π Task API allows you to keep a complete record of your tasks and pending tasks all from one place.
- Table of Contents
- π Demo
- System Design
- Entity-Relationship Diagram
- π‘Features
- π§βπ» Installation Steps
- The process
- Licence
- Author
In order to see the application I created my own relationship model, identifying a one-to-many relationship between users and tasks.
Here're some of the projects's best features:
- Creation of the project using FastAPI β
- Setup a Databse PostgreSQL β
- Define Data models for tasksβ
- Define schemas for validate data using pydantic β
- Create my own sql script to create the tables
- Implement crud endpoints for Tasks β
- Crear comprehensive documentation using Swagger β
- Use Docker to containerize the application for easy deployment and scalability.β
-
Clone the repository
git clone https://github.com/javieramayapat/api-tasks.git
-
Create your virtual enviromen with the command
py -m venv venv
-
Install requirements in your virtual enviroment
pip install -r requirements.txt
-
Create the env file in the root of the project
.env
and copy the content of the.env.example
to configurate environment variables. -
You can run the following command to buil the image.
$ docker-compose build
-
Once the image is built, run the container:
$ docker-compose up -d
-
If you want to be faster in launching the project you can use the following command to perform the above two steps in one.
$ docker-compose up --build
-
Now go to http://127.0.0.1:8000/docs and enjoy the app π.
Technologies used in this project:
- Docker π
- Python π
- FastAPI π
- Pydantic π―
- PostgreSQL π
- SQLAlchemy βοΈ
To get started you just need to download docker on your machine, I leave the link right here. β‘οΈ Docker.
This project is licensed under the MIT License
Made with π by javieramayapat