Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 2.06 KB

README.md

File metadata and controls

72 lines (47 loc) · 2.06 KB
Raw

toDoApp-fastAPI

This API is written with FastAPI and Python for a ToDo app.

Prerequisites

Before to start, please note this app is built with Python 3.11 in mind. Please mind that using previous version might create issues on your development experience.

Install the virtual environment

If it is the first time you start the application on your machine, remember to set up a virtual machine:

# For Windows users
python3.exe -m venv .venv

# From Mac/Linux users
python3 -m venv .venv

Then activate with the following command to enter the environment:

# For Windows users
.venv\Scripts\activate

# From Mac/Linux users
source venv/bin/activate

Then install dependencies:

pip install -r requirements.txt

Environment variables

Environment variables included in the .env file will be used inside the application. This file is excluded from source control, so you want to create it in the root folder (at the same level as main.py), with the same structure as default.env.

You can also locally use a local.env file, as an alternative to .env. It is also excluded from git.

The list of necessary environment variables is the following:

  • DEBUG: whether FastAPI should start in debug mode or not
    • default: false
  • LOG_LEVEL: from which level log will be printed out
    • default: INFO
    • possible values: NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL
  • MONGO_URL (mandatory): the path of the Mongo database to connect with, containing host and port;
  • DATABASE_NAME (mandatory): the name of the MongoDB database;
  • HASH_KEY (mandatory): this is a 32 letter hash that will be used to hash passwords (e.g. via Linux, you can generate it typing openssl rand -hex 32 on a terminal)

How to run

You can start the application with the following:

uvicorn main:app --reload

It will be exposed at http://localhost:8000

How to test

Every test should be included in the tests folder. We use Pytest to run tests. Simply launch:

pytest

to let the magic happen.