README.md

Memote Webservice

N.B.: All relevant development of the web service is happening at https://github.com/DD-DeCaF/memote-webservice. Some deployment details are DD-DeCaF specific but we currently do not have the resources to maintain both. This repository is therefore archived.

Post-cookiecutter steps

Perform the following steps after creating a new service from the cookiecutter.

• Create the following environment variables in Travis CI:
  • ENVIRONMENT: testing
  • FLASK_APP: src/memote_webservice/wsgi.py
  • SLACK_ACCOUNT: Workspace name, e.g. biosustain
  • SLACK_TOKEN: Find it here
  • SLACK_CHANNEL: Normally #decaf-notifications
  • DOCKER_PASSWORD: For push access to Docker Hub
• Remove this section from the README.

Development

Run make setup first when initializing the project for the first time. Type make to see all commands.

Environment

Specify environment variables in a .env file. See docker-compose.yml for the possible variables and their default values.

• Set ENVIRONMENT to either
  • development,
  • testing, or
  • production.
• SECRET_KEY Flask secret key. Will be randomly generated in development and testing environments.
• SENTRY_DSN DSN for reporting exceptions to Sentry.
• ALLOWED_ORIGINS: Comma-seperated list of CORS allowed origins.