Welcome to the PyNotes-API repository! This is a simple guide to help you get started with setting up and running the PyNotes-API project.
The actual version is v0.1.0.
Follow these steps to set up and run the project on your local machine:
Clone the repository:
git clone [email protected]:vcjuliocesar/pynotes-api.git
Create enviroment file rename .env.example by .env
Create a Virtual Environment:
python3 -m venv env
Activate the Virtual Environment: On macOS/Linux:
source env/bin/activate
On Windows:
.\env\Scripts\activate
Install Dependencies:
pip3 install -r requirements.txt
Run the Project:
uvicorn main:app --reload
if you prefer to use docker follow these steps, it is important that you have docker installed on your computer
docker compose build
docker compose up
Once the project is up and running, you can access it through your browser or API client.