Skip to content

markgdawson/cogs3

 
 

Repository files navigation

cogs3

Project Management System


Build Status codecov license


Development


  1. Checkout the source code.

    mkdir -p ~/code && cd $_
    git clone git@github.com:issa16/cogs3.git
  2. Create an env file.

    cd cogs3
    mv cogs3/.template_env cogs3/.env
  3. Build and run.

    docker-compose up -d

    Note: If docker-compose hangs when creating the cogs3_web_1 container, you may need to add the cogs3 directory to the list of file sharing resources.

  4. Obtain an SSH connection to the cogs3_web_1 container.

    docker ps
    docker exec -it <id_of_cogs3_web_1_container> bash
  5. Run the database migrations.

    python3 manage.py migrate
  6. Load data fixtures into the database.

    python3 manage.py loaddata institutions.json
    python3 manage.py loaddata systems.json
  7. Create an admin user.

    python3 manage.py createsuperuser
  8. Generate history tables.

    python3 manage.py populate_history --auto
  9. Run the unit tests.

    python3 manage.py test -v 3
  10. Generate coverage report.

    coverage run manage.py test
    coverage html
  11. Enter http://localhost:5000/ in a browser to see the application running.


Deployment


If you are running a production server with at least one institution and cluster that makes use of priority calculations, then set up the requisite Cron jobs to update priorities daily, as described in the priority README.


Sequence Diagrams


About

Project Management System

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 88.1%
  • HTML 11.2%
  • Other 0.7%