Skip to content

aahilgert/CourseFlow

 
 

Repository files navigation

CourseFlow

CircleCI

CourseFlow is a pedagogical tool for planning activities, courses, and programs, which is designed to enable Research Practice Partnerships between instructors, designers, and researchers.

Setting up the development server

  1. Set up a virtualenv.

    python3 -m venv dev_venv
    
  2. Activate the virtualenv.

    source dev_venv/bin/activate
    
  3. Install the requirements.

    (dev_venv) pip install -r requirements.txt
    
  4. Install pre-commit (optional).

    pre-commit install
    
  5. Install node modules.

    yarn install | npm i
    
  6. Build minified JS files.

    yarn run gulp build-js | ./node_modules/gulp/bin/gulp.js build-js
    
  7. Migrate

    (dev_venv) python3 course_flow.py migrate
    
  8. If you don't have a local_settings.py set up, change line 25 in settings.py to:

    DEBUG = True
    
  9. Run the Django development server.

    (dev_venv) python3 course_flow.py runserver
    
  10. Register at:

    127.0.0.1:8000/register
    
  11. Create default strategies and disciplines.

    (dev_venv) python3 course_flow.py create_saltise_strategies
    (dev_venv) python3 course_flow.py create_base_disciplines
    
  12. For testing before commits, run:

    (dev_venv) python3 course_flow.py test
    

    or:

    (dev_venv) pytest
    
  13. To package a version:

    tox --recreate
    
  14. When using in another project:

    add a COURSE_FLOW_RETURN_URL value to your settings.py
    

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 52.1%
  • JavaScript 36.0%
  • CSS 8.7%
  • HTML 3.2%