Start a REST API's using Flask in 30 sec. One-click deploy to Heroku Server (free) & integrated with Gitpod.
Create flask API's in minutes, 📹 watch the video tutorial.
$ pipenv run deploy
..env
file.This template installs itself in a few seconds if you open it for free with Codespaces (recommended) or Gitpod. Skip this installation steps and jump to step 2 if you decide to use any of those services.
Important: The boiplerplate is made for python 3.10 but you can change the
python_version
on the Pipfile.
The following steps are automatically runned withing gitpod, if you are doing a local installation you have to do them manually:
pipenv install;
psql -U root -c 'CREATE DATABASE example;'
pipenv run init;
pipenv run migrate;
pipenv run upgrade;
Note: Codespaces users can connect to psql by typing:
psql -h localhost -U gitpod example
There is an example API working with an example database. All your application code should be written inside the ./src/
folder.
For a more detailed explanation, look for the tutorial inside the docs
folder.
You have to migrate and upgrade the migrations for every update you make to your models:
$ pipenv run migrate # (to make the migrations)
$ pipenv run upgrade # (to update your databse with the migrations)
pipenv run start
command your API will start running live and you can open it by clicking in the "ports" tab and then clicking "open browser".✋ If you are working on a coding cloud like Codespaces or Gitpod make sure that your forwared port is public.
This boilerplate it's 100% read to deploy with Render.com and Herkou in a matter of minutes. Please read the official documentation about it.
This template was built as part of the 4Geeks Academy Coding Bootcamp by Alejandro Sanchez and many other contributors. Find out more about our Full Stack Developer Course, and Data Science Bootcamp.
You can find other templates and resources like this at the school github page.