flaskie

Overview

A simple flask api to handle user authentication based on Flask and flask-RESTPlus

view on docker

view on heroku

Required Features

• Users can create an account and log in.
• Users can update thier details
• Users can delete thier account
• Users can view the account details
• Admin can view all users in the app
• Admin can view his/her details
• Admin can delete a user with the specified user_id
• Admin can get a user with the specified user_id
• Admin can update a user with the specified user_id
• Role based permission system
• It is auto documented

##Exploring the demo."

Create a new user at the 'POST /auth/user' endpoint. Get the user access token from the response. Click the authorize button and add the token in the following format.

Bearer (jwt-token without the brackets)

There is also a built-in user:

paulla (administrator with all permissions) with password mermaid

Authorization token(with the help of)\n"

Jwt-Extended"

Installation and Setup

Clone the repository.

git clone https://github.com/asheuh/flaskie

Navigate to the API folder

bash
cd flaskie

Create a virtual environment and activate

On linux

$ python -m venv venv
$ source venv/bin/activate

On Windows

py -3 -m venv venv
venv\Scripts\activate

Install requirements( with pip)

$ pip install -r requirements.txt

Running the application

After the configuration, you will run the app

Setup the application for develepment to make sure all the requiremente are installed

$ python setup.py develop

Create super user

$ flask createsuperuser

Run the application

$ flask run

Url for endpoints

http://127.0.0.1:5000/api/v1/
http://127.0.0.1:5000/api/v2/

The app is deploy to heroku with the following url

• here is the live demo on heroku