Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.79 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.79 KB

Flask RESTful API Boilerplate (By Wyn)

This is a boilerplate project for building RESTful APIs using Flask and Flask-RESTful. It provides a solid foundation and a set of best practices to kickstart your API development.

Note: I use this boilerplate for my work projects. It might not be suitable for other use cases without modifications.

Features

  • Flask and Flask-RESTful for building RESTful APIs
  • SQLAlchemy for database management
  • JWT authentication using cookies for secure API access

Getting Started

To get started with the flask-restful-api-boilerplate, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/flask-restful-api-boilerplate.git
  2. Navigate to the project directory: cd flask-restful-api-boilerplate
  3. Create a virtual environment: python -m venv .venv
  4. Activate the virtual environment:
    • On Windows: .venv\Scripts\activate
    • On macOS/Linux: source .venv/bin/activate
  5. Install the required dependencies: pip install -r requirements.txt
  6. Set up the database: flask db init && flask db migrate && flask db upgrade
  7. Start the development server: python app1.py

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.