clemsau / locuss-backend

Backend of the locuss flashcard app

locuss-backend

Backend of the Locuss flashcard app. Check out the project's documentation.

Checkout the project's roadmap

The locuss-frontend repository is also open to contributions

Table of content

• Project structure
• Get started
  • Prerequisites
  • Local development
• Deployment

Project structure

/api
    /cards      # Card model application
    /common     # Mixins
    /config     # Django configuration
    /decks      # Deck model application
    /users      # User model application
/docs
/requirements
.coveragerc
.dockerignore
.gitignore
.travis.yml
docer-compose.yml
Docerfile
manage.py
mkdocs.yml
README.md
setup.cfg
wait_for_postgres.py

Get started

Prerequisites

• Docker

Local Development

Start the dev server for local development:

docker-compose up

Run a bash shell in the container:

docker-compose run --rm web bash

Run a command inside the docker container:

docker-compose run --rm web [command]

Access the API's Redoc locally:

http://localhost:8000/redoc/

Deployment

The application is deployed on heroku