eyalatox / lost-pets-api

API for reporting lost pets.

Lost Pets API

About  |   Technology  |   Getting Started  |   Usage  |   Roadmap  |   Contributing  |   License

About the Project

API for reporting lost pets.

Technology

This project was developed with the following technologies:

• Python
• FastAPI

Getting Started

Prerequisites

• Python
• Poetry

Install and Run

1. Clone the repository:

git clone https://github.com/WesGtoX/lost-pets-api.git

2. Install the dependencies:

poetry install

3. Run:

poetry run uvicorn app.main:app --reload

Usage

Lost Pets Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

How to contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project.
2. Create your Feature Branch git checkout -b feat/my-feature.
3. Commit your Changes git commit -m 'feat: My new feature'.
4. Push to the Branch git push origin feat/my-feature.
5. Open a Pull Request.

After the merge of your pull request is done, you can delete your branch.

License

Distributed under the MIT License. See LICENSE for more information.

---

Made with ♥ by Wesley Mendes 👋