A flask-driven restful API for Bucketlist interactions
- Python3 - A programming language that lets you work more quickly (The universe loves speed!).
- Flask - A microframework for Python based on Werkzeug, Jinja 2 and good intentions
- Virtualenv - A tool to create isolated virtual environments
- PostgreSQL – Postgres database offers many advantages over others.
- Minor dependencies can be found in the requirements.txt file on the root folder.
Installation / Usage
If you wish to run your own build, first ensure you have python3 globally installed in your computer. If not, you can get python3 here.
After this, ensure you have installed virtualenv globally as well. If not, run this:
$ pip install virtualenv
Git clone this repo to your PC
$ git clone email@example.com:gitgik/flask-rest-api.git
Cd into your the cloned repo as such:
$ cd flask-rest-api
Create and fire up your virtual environment in python3:
$ virtualenv -p python3 venv $ pip install autoenv
Create a .env file and add the following:
source venv/bin/activate export SECRET="some-very-long-string-of-random-characters-CHANGE-TO-YOUR-LIKING" export APP_SETTINGS="development" export DATABASE_URL="postgresql://localhost/flask_api"
Save the file. CD out of the directory and back in.
Autoenvwill automagically set the variables. We've now kept sensitive info from the outside world!
Install your requirements
(venv)$ pip install -r requirements.txt
On your psql console, create your database:
> CREATE DATABASE flask_api;
Then, make and apply your Migrations
(venv)$ python manage.py db init (venv)$ python manage.py db migrate
And finally, migrate your migrations to persist on the DB
(venv)$ python manage.py db upgrade
On your terminal, run the server using this one simple command:
(venv)$ flask run
You can now access the app on your local browser by using
Or test creating bucketlists using Postman