williamcanin / api-flask-restful

:snake: Sample API Flask RESTful

About

Simple API using Flask.

Requirements

• Python = 3.9
• Poetry >= 1.1
• Direnv
• Linux/Mac

Clone

git clone https://github.com/williamcanin/api-flask-restful.git
cd api-flask-restful

Configuration

1 - Create database in PostGreSQL:

sudo -i -u postgres psql
postgres=# CREATE DATABASE "<DB_NAME>";
postgres=# \q

2 - Install dependencies:

poetry env use 3.9.9
poetry shell
poetry install

Note: Use pyenv to install specific version of Python.

3 - Set variables environment:

echo "export FLASK_APP=app:app" >> .envrc
echo "export FLASK_ENV=development" >> .envrc
echo "export DATABASE_URL=postgres://postgres:<PASSWORD>@localhost:5432/<DB_NAME>" >> .envrc
echo "export SECRET_KEY=\"<YOUR_SECRET_KEY>\"" >> .envrc

4 - Permission enable for variables environment:

direnv allow .

5 - Migrate and Upgrade models for database:

flask db init
flask db migrate
flask db upgrade

6 - Create superuser:

flask createsuperuser

Using:

1 - Run API:

flask run

Using the Insomnia or Postman for manipulation routes.

---

(c) William Canin - 2021