- Create a virtual environment by executing the following command in the terminal:
- Unix/macOS:
python3 -m venv env-name
- Windows:
python -m venv env-name
- Replace
env-name
with a desired name for the virtual environment.
- Unix/macOS:
- Activate the virtual environment using the following command in the terminal:
- Unix/macOS:
source env-name/bin/activate
- Windows:
.\env-name\Scripts\activate
- Unix/macOS:
- Install project dependencies by executing the following command in the terminal:
pip install -r requirements.txt
- Run the test cases by navigating to the project's root directory in the terminal and executing the following command:
pytest
- Start the development server by executing the following command in the terminal:
uvicorn app.main:app --reload
- To view the documentation, navigate to
localhost:8000/docs
in your web browser.