https://github.com/jpcadena/aws-microservices
AWS Microservices project
https://github.com/jpcadena/aws-microservices
Last synced: 7 months ago
JSON representation
AWS Microservices project
- Host: GitHub
- URL: https://github.com/jpcadena/aws-microservices
- Owner: jpcadena
- Created: 2024-12-28T20:47:25.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-19T01:50:38.000Z (11 months ago)
- Last Synced: 2025-02-19T02:36:09.993Z (11 months ago)
- Language: Python
- Size: 169 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aws-microservices
Table of Contents
## About The Project
![Project][project-screenshot]
This backend project is a FastAPI-based template designed to serve as a robust,
reliable, and RESTful API backend. It is crucial for facilitating user
authentication, real-time monitoring, data processing, and an advanced alerting
system. By leveraging the principles of RESTful architecture, this API ensures
standardized communication and a scalable, maintainable infrastructure for the
associated mobile application. This project is not only vital for the
functionality it provides but also for ensuring the scalability and
maintainability of the overall solution.
## Built With
This backend project is about Aws microservices and is built using a suite of
modern, powerful technologies and frameworks to ensure high performance, ease of development, and robustness:
[![Python][python-shield]][python-url] [![AWS][aws-shield]][aws-url] [![FastAPI][fastapi-shield]][fastapi-url] [![Pydantic][pydantic-shield]][pydantic-url] [![Starlette][starlette-shield]][starlette-url] [![Uvicorn][uvicorn-shield]][uvicorn-url] [![Pytest][pytest-shield]][pytest-url] [![isort][isort-shield]][isort-url] [![Black][black-shield]][black-url] [![Ruff][ruff-shield]][ruff-url] [![MyPy][mypy-shield]][mypy-url] [![pre-commit][pre-commit-shield]][pre-commit-url] [![GitHub Actions][github-actions-shield]][github-actions-url] [![Pycharm][pycharm-shield]][pycharm-url] [![Visual Studio Code][visual-studio-code-shield]][visual-studio-code-url] [![Markdown][markdown-shield]][markdown-url] [![Swagger UI][swagger-ui-shield]][swagger-ui-url] [![License: MIT][license-shield]][license-url]
The system is composed of the following main components, each playing a
crucial role in providing a scalable, maintainable, and robust application:
- **FastAPI Backend**: Serves as the core of the RESTful API, handling incoming
HTTP requests, processing data, and sending responses. It's designed for high
performance and encourages standard API development practices.
This project adheres to RESTful design principles, ensuring an intuitive and
standard approach to API development. This design facilitates easy integration,
scalability, and interaction with various clients, including web and mobile
applications. The API provides clear, resource-oriented URLs, uses HTTP response
codes to indicate API errors, and employs JWT for secure, stateless
authentication.
## Getting Started
### Prerequisites
- [Python 3.13][python-docs]
- [![uv][uv-shield]][uv-url]
### Installation
1. Clone the **repository**
```bash
git clone https://github.com/jpcadena/aws-microservices.git
```
2. Change the directory to **root project**
```bash
cd aws-microservices
```
3. Create a **virtual environment** named *.venv* in the working directory
```bash
uv venv
```
4. Activate **environment** in Windows
```bash
.\venv\Scripts\activate
```
5. Activate **environment** in macOS or Linux
```bash
source venv/bin/activate
```
6. Update project's environment by syncing all of its dependencies and installing them
```bash
uv sync
```
## Usage
1. **Setting up environment variables:**
If you find a `.env.sample` in the project directory, make a copy of it and
rename to `.env`.
```bash
cp .env.sample .env
```
This `.env` file will be used to manage your application's environment
variables.
2. **Configuring your credentials:**
Open the `.env` file in a text editor and replace the placeholder values with
your actual credentials.
```bash
# .env file
POSTGRES_USER=your_database_user
SECRET_KEY=your_api_key
```
Be sure to save the file after making these changes.
3. **Starting the server:**
To start the local server on your machine, run the following command in your
terminal:
```bash
uvicorn main:app --reload
```
The `--reload` flag enables hot reloading, which means the server will
automatically update whenever you make changes to the code.
4. **Interacting with the app:**
Once your server is running, you can interact with it using any API client
like Postman or your web browser. You can send GET, POST, PUT, DELETE
requests to the API endpoints as defined in your `main.py` file. For example,
to get all users, you can send a GET request to
`http://localhost:8000/api/v1/users`.
5. **Using Swagger UI:**
FastAPI provides automatic interactive API documentation using Swagger UI.
Once your server is up and running, you can go to
`http://localhost:8000/docs` in your web browser to access it. From there,
you can explore and interact with your API directly.
## Contributing
[![GitHub][github-shield]][github-url]
Please read our [contributing guide](CONTRIBUTING.md) for details on our code of
conduct, and the process for submitting pull requests to us.
## Security
For security considerations and best practices, please refer to
our [Security Guide](SECURITY.md) for a detailed guide.
## Code Of Conduct
We enforce a code of conduct for all maintainers and contributors. Please read
our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations before
making any contributions.
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
## Contact
- [![LinkedIn][linkedin-shield]][linkedin-url]
- [![Outlook][outlook-shield]](mailto:jpcadena@espol.edu.ec?subject=[GitHub]fastapi-boilerplate)
[project-screenshot]: static/images/project.png
[python-docs]: https://docs.python.org/3.11/
[linkedin-shield]: https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white
[outlook-shield]: https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=for-the-badge&logo=microsoft-outlook&logoColor=white
[python-shield]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
[fastapi-shield]: https://img.shields.io/badge/FastAPI-FFFFFF?style=for-the-badge&logo=fastapi
[pydantic-shield]: https://img.shields.io/badge/Pydantic-FF43A1?style=for-the-badge&logo=pydantic&logoColor=white
[starlette-shield]: https://img.shields.io/badge/Starlette-392939?style=for-the-badge&logo=starlette&logoColor=white
[uvicorn-shield]: https://img.shields.io/badge/Uvicorn-2A308B?style=for-the-badge&logo=uvicorn&logoColor=white
[pycharm-shield]: https://img.shields.io/badge/PyCharm-21D789?style=for-the-badge&logo=pycharm&logoColor=white
[markdown-shield]: https://img.shields.io/badge/Markdown-000000?style=for-the-badge&logo=markdown&logoColor=white
[swagger-ui-shield]: https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white
[github-shield]: https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white
[ruff-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json
[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge&logo=appveyor
[mypy-shield]: https://img.shields.io/badge/mypy-checked-2A6DB2.svg?style=for-the-badge&logo=appveyor
[visual-studio-code-shield]: https://img.shields.io/badge/Visual_Studio_Code-007ACC?style=for-the-badge&logo=visual-studio-code&logoColor=white
[isort-shield]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
[github-actions-shield]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white
[pre-commit-shield]: https://img.shields.io/badge/pre--commit-F7B93E?style=for-the-badge&logo=pre-commit&logoColor=white
[license-shield]: https://img.shields.io/badge/License-MIT-yellow.svg
[uv-shield]: https://img.shields.io/badge/uv-toolkit-blue?logo=uv&style=flat-square
[pytest-shield]: https://img.shields.io/badge/Pytest-0A9EDC?style=for-the-badge&logo=pytest&logoColor=white
[aws-shield]: https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white
[linkedin-url]: https://linkedin.com/in/juanpablocadenaaguilar
[python-url]: https://www.python.org/
[fastapi-url]: https://fastapi.tiangolo.com
[pydantic-url]: https://docs.pydantic.dev
[starlette-url]: https://www.starlette.io/
[uvicorn-url]: https://www.uvicorn.org/
[pycharm-url]: https://www.jetbrains.com/pycharm/
[markdown-url]: https://daringfireball.net/projects/markdown/
[swagger-ui-url]: https://swagger.io/
[github-url]: https://github.com/jpcadena/fastapi-boilerplate
[ruff-url]: https://beta.ruff.rs/docs/
[black-url]: https://github.com/psf/black
[mypy-url]: http://mypy-lang.org/
[visual-studio-code-url]: https://code.visualstudio.com/
[isort-url]: https://pycqa.github.io/isort/
[github-actions-url]: https://github.com/features/actions
[pre-commit-url]: https://pre-commit.com/
[license-url]: https://opensource.org/licenses/MIT
[uv-url]: https://docs.astral.sh/uv/getting-started/installation/
[pytest-url]: https://docs.pytest.org/
[aws-url]: https://aws.amazon.com/
