Flask-Rest is a lightweight and flexible REST API project built using the Flask web framework. It provides a solid foundation for developing RESTful web services, making it easy to create, update, and retrieve data through HTTP requests.
-
Modular Structure: The project is organized into modular components such as routes, models, and views, promoting maintainability and scalability.
-
Configurability: Configuration settings are stored in separate files, with sensitive information placed in an instance folder, enhancing security and flexibility.
To run the Flask-Rest project:
- Navigate to the project directory.
- Run
pip install -r requirements.txtto install the required packages. - Run config.bat or config.sh to set the environment variables.
- Run the app with
flask run. - Or just run python run.py
This is a template repository, so you can use it as a starting point for your own projects. You can modify the project structure, add new features, and customize the code to suit your needs. clone the repository and start building your own RESTful web services.
on top right corner of the page,
click on the "Use this template" button to create a new repository
with the same directory structure and files.
The development server will start, and you can access the app at http://127.0.0.1:5000.