Skip to content

Latest commit

 

History

History
executable file
·
86 lines (45 loc) · 2.52 KB

README.rst

File metadata and controls

executable file
·
86 lines (45 loc) · 2.52 KB

OLC Webportal V2

A portal to commonly used CFIA-OLC genomics tools.

Built with Cookiecutter Django + Docker
License:MIT

Cookiecutter Django Reference

Docker development: docker.

Settings: settings.

Basic Commands

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

  • To create an superuser account, use this command:

    $ docker-compose -f local.yml run django python manage.py createsuperuser
    

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Live reloading and Sass CSS compilation

See the following for CSS to SASS compilation docs: Live reloading and SASS compilation.

Celery

This app comes with Celery.

To run a celery worker:

cd olc_webportalv2
celery -A olc_webportalv2.taskapp worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Sentry (currently non-functional)

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.