Skip to content

lamedevelop/cucumber

Folders and files

NameName
Last commit message
Last commit date
Jul 13, 2021
Jul 25, 2021
Jul 25, 2021
Jul 24, 2021
Jul 10, 2021
Jul 25, 2021
Jul 25, 2021
Jul 18, 2021
Jul 18, 2021
Jul 14, 2021
Jul 18, 2021
Jul 24, 2021
Jul 24, 2021

Repository files navigation

Cucumber

Cucumber food delivery project. Backend and landing page.

Linting

Quickstart

You must have docker and docker-compose tools installed to run the application. Simply you can just run following command.

Run full project from project root:

make docker

Or run docker-compose manually:

docker-compose up -d --build

Also you can run parts of application separately. It's useful for debugging.

  1. Install requirements
  2. Run db container with: make db
  3. Run alembic migrations: make alembic
  4. Run app locally: make local

Up

What's inside

All web routes of the app available on /docs path.

Project structure presented below:

app
├── api              - routing and web related modules
│
├── db               - db related modules
│   ├── migrations   - generated alembic migrations
│   └── models       - db models
│   └── schema.py    - description of db structure
│
├── internal         - internal modules
│
└── main.py          - FastAPI application: creation and configuration

Up