https://github.com/wesgtox/lost-pets-api
API for reporting lost pets.
https://github.com/wesgtox/lost-pets-api
fastapi fastapi-sqlalchemy postgresql pydantic python python-poetry rest-api
Last synced: 4 months ago
JSON representation
API for reporting lost pets.
- Host: GitHub
- URL: https://github.com/wesgtox/lost-pets-api
- Owner: WesGtoX
- License: mit
- Created: 2021-12-04T20:13:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-06T14:34:02.000Z (almost 4 years ago)
- Last Synced: 2025-03-09T19:42:17.264Z (8 months ago)
- Topics: fastapi, fastapi-sqlalchemy, postgresql, pydantic, python, python-poetry, rest-api
- Language: Python
- Homepage: https://lost-pets-wes.herokuapp.com
- Size: 65.4 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
## Getting Started
### Prerequisites
- [Python](https://www.python.org/downloads/)
- [Poetry](https://python-poetry.org/docs/#installation)
### Install and Run
1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/lost-pets-api.git
```
2. Install the dependencies:
```bash
poetry install
```
3. Run:
```bash
poetry run uvicorn app.main:app --reload
```
## Usage
[Lost Pets Documentation](https://lost-pets-wes.herokuapp.com/docs)
## Roadmap
See the [open issues](https://github.com/WesGtoX/lost-pets-api/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](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: