Skip to content

Commit 0d3acd8

Browse files
committed
readme file updated
1 parent aba4441 commit 0d3acd8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FAST-API-APP
22

3-
A modern, scalable, and production-ready FastAPI application designed for managing users, posts, and votes. This project demonstrates best practices in API development, testing, and deployment, making it an excellent showcase for recruiters and collaborators.
3+
A modern, scalable, and production-ready FastAPI application designed to manage users, posts, and votes with high efficiency. This project leverages best practices in API development, incorporating automated testing, continuous integration, and continuous deployment to ensure reliability and maintainability. It demonstrates a robust architecture for building high-performance APIs, with a focus on security, containerization, and cloud deployment. The application is optimized for real-world use cases, ensuring seamless scalability and ease of maintenance.
44

55
---
66

@@ -12,6 +12,7 @@ A modern, scalable, and production-ready FastAPI application designed for managi
1212
- **Authentication**: Secure user authentication using OAuth2 and JWT tokens.
1313
- **Database Integration**: SQLModel and Alembic for database modeling and migrations.
1414
- **Testing**: Comprehensive unit and integration tests using `pytest`.
15+
- **OWASP Top 10 Security**: This project incorporates key OWASP Top 10 security practices, such as secure authentication using OAuth2 and JWT, preventing SQL injection through SQLModel, and enforcing proper access control to ensure users can only interact with their own data. Tests are included to validate these protections and ensure the application is resilient to common security vulnerabilities..
1516
- **Containerization**: Docker support for seamless development and production environments.
1617
- **CI/CD**: Automated testing and deployment pipelines using GitHub Actions and Render.
1718
- **API Documentation**: Interactive API documentation with Swagger UI and ReDoc.
@@ -207,6 +208,7 @@ This project uses GitHub Actions for automated testing and deployment:
207208
| Variable | Description |
208209
| ----------------------------- | -------------------------------- |
209210
| `DATABASE_URL` | Database connection URL |
211+
| `TEST_DATABASE_URL` | Test Database connection URL |
210212
| `SECRET_KEY` | Secret key for JWT |
211213
| `ALGORITHM` | Algorithm for JWT |
212214
| `ACCESS_TOKEN_EXPIRE_MINUTES` | Token expiration time in minutes |
@@ -218,3 +220,7 @@ This project is licensed under the [MIT License](LICENSE).
218220
```
219221
220222
```
223+
224+
## 👨‍💻 Author
225+
226+
COT_WORLD: A passionate software developer who loves building scalable and efficient applications. Connect with me on [LinkedIn](https://www.linkedin.com/in/hardik-chaudhary/).

0 commit comments

Comments
 (0)