Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.08 KB

README.md

File metadata and controls

44 lines (31 loc) · 1.08 KB

Mangee Flask-RESTful

Mangee Flask-RESTful is a template/framework designed to simplify the process of building scalable RESTful Flask applications.

Getting Started

  • Clone the repository

    git clone https://github.com/RapDoodle/mangee-flask-restful.git
  • Install required Python packages

    For Linux users

    $ pip3 install -r requirements.txt

    For Windows users

    $ pip install -r requirements.txt

    Please be noted that some dependencies may not be installed on Debian and Ubuntu. If an error occurred while installing bcrypt, run the following command

    sudo apt-get install build-essential libffi-dev python-dev
  • Spinup a development server

    $ python3 run.py dev

    In the last argument, dev specifies the name of the configuration. Please visit the documents on configurations under the docs folder for more information about the configurations.

Contributors

  • Bowen WU (@RapDoodle)

License

The project is licensed under the GNU General Public License v3.

Copyright

Copyright (c) 2021.