Public API to have fun and share knowledge about our domestic pets. πΈπ€πΆ
- οΏ½Table of Contents
- π Demo
- π‘Features
- π§βπ» Installation Steps
- The process
- Licence
- Author
Here're some of the projects's best features:
- Get a list of facts about our favorite pets. [π₯,π₯,π₯]
- Get the detail of a fact in specific. π₯
- List a list with our best pest registered [π€,πΈ,πΆ]
- Get a pet detail πΈ
-
Clone the repository
-
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