https://github.com/ganggas95/flask-api-solid-boilerplate
https://github.com/ganggas95/flask-api-solid-boilerplate
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ganggas95/flask-api-solid-boilerplate
- Owner: ganggas95
- License: mit
- Created: 2024-02-24T09:05:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-26T02:09:16.000Z (about 1 year ago)
- Last Synced: 2024-04-17T05:36:39.640Z (about 1 year ago)
- Language: Python
- Size: 220 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask API SOLID Boilerplate
This repository provides a boilerplate for building a RESTful API using Flask with a focus on SOLID principles.
## Features
- Implements a basic Flask application structure for building scalable and maintainable APIs
- Integrates SOLID design principles to promote code reusability, maintainability, and testability
- Includes a sample CRUD (Create, Read, Update, Delete) API implementation to demonstrate usage
- Provides a clear directory structure and separation of concerns for easy navigation and maintenance
- Includes instructions for setting up the boilerplate and running the sample API
## Getting Started
To get started with the Flask API SOLID Boilerplate, follow these steps:
1. Clone the repository to your local machine
2. Install the required dependencies using pip or pipenv
3. Configure the environment variables and settings as needed
4. Run the Flask application and access the sample CRUD API endpoints
## Usage
- Use this boilerplate as a starting point for building Flask-based RESTful APIs
- Leverage the SOLID principles to enhance the maintainability and scalability of your API codebase
- Customize and extend the boilerplate to suit your specific project requirements
## Contributions
Contributions and feedback are welcome! If you have ideas for improvements or new features, feel free to submit a pull request or open an issue.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.