Skip to content

SCUEvals/scuevals-api

Repository files navigation

CircleCI Status for SCUEvals/scuevals-api Coverage Status Code Climate License

Running the API

  1. Install the app and its dependencies by running pip install -e . in the root folder.
  2. Set the following environment variables:
    • DATABASE_URL=<DB URL>
    • FLASK_ENV=development (options: production, development, test)
    • JWT_SECRET_KEY=<256-BIT SECRET>
    • GOOGLE_CLIENT_ID=<YOUR ID>
  3. Initialize the database by running app initdb.
  4. Run app run to start the API server.

Running the Tests

Run python setup.py test.

Documentation

The API documentation is available on Apiary. Documentation for branches other than master can be found at scuevals.github.io/scuevals-api/?branch=nameofbranch.