Skip to content

jdrodriguezh/flask-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flask template for backend REST APIs (mostly) made with ❤️ and ☕

License Issues forks stars size

This is a template to start developing Flask projects. The project includes sample tests with Python's built-in testing framework unittest, how the project folders should be structured and good practices of Python and Flask.

Motivation ❓

Since a long time ago, I wanted to learn Python. I decided to start developing simple REST APIs to get going and this led me to this project!

Installation 📥

> git clone https://github.com/jdrodriguezh/flask-template

>  cd  flask-template

> pipenv shell

> pipenv install

> py ./run.py

Bugs 🐛

This project is getting upgrades in my free time if there is a problem please create a bug report in the issues section.

License 📜

Available Scripts 📜

On the project root directory, you can run:

py ./run.py

Runs the project in the development mode.

flask db init

Adds the migrations folder to your project. This needs to be run only once, when running your first migration.

flask db migrate

Generates the migration script.

flask db upgrade

Applies the migration to the database.

IMPORTANT: Only flask db migrate and flask db upgrade need to be run every time the models change.

py -m unittest -v

Runs all the tests in our /test folder.

About

Template to start developing Flask projects. This template includes tests with unittest.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors