code refactor, readme, docker, tests

Author: ksh7

.gitignore

@@ -1,9 +1,7 @@
 flask/
 *.pyc
 dev
-node_modules
-app/database.db
-app/build
+api/apidata.db
 yarn.lock
 yarn-error.log
 *.psd

Dockerfile

@@ -0,0 +1,9 @@
+FROM python:3.8
+
+ENV FLASK_APP run.py
+
+COPY run.py requirements.txt ./
+
+RUN pip install -r requirements.txt
+
+CMD ["run:app", "flask shell"]

README.md

@@ -1 +1,101 @@
-# api-server-flask
+## api-server-flask
+
+`api-server-flask` is a boilerplate starter template designed to help you quickstart your Flask based REST API server development. It has all the ready-to-use bare minimum essentials.
+
+
+## Features
+
+- APIs: Signup, Login with (email, password), Logout, Edit User
+- SQLAlchemy + SQLite
+- Configs
+- Requirements
+- Tests: SignUp, Login
+
+
+## Table of Contents
+
+1. [Getting Started](#getting-started)
+2. [Project Structure](#project-structure)
+3. [Modules](#modules)
+4. [Testing](#testing)
+
+
+## Getting Started
+
+clone the project
+
+```bash
+$ git clone https://github.com/app-generator/api-server-flask.git
+$ cd api-server-flask
+```
+
+create virtual environment using python3 and activate it (keep it outside our project directory)
+
+```bash
+$ python3 -m venv /path/to/your/virtual/environment
+$ source <path/to/venv>/bin/activate
+```
+
+install dependencies in virtualenv
+
+```bash
+$ pip install -r requirements.txt
+```
+
+setup `flask` command for our app
+
+```bash
+$ export FLASK_APP=run.py
+$ export FLASK_ENV=development
+```
+
+initialize database, check `run.py` for shell context
+
+```bash
+$ flask shell
+$ db.create_all()
+```
+
+start test APIs server at `localhost:5000`
+
+```bash
+$ python run.py
+```
+or 
+```bash
+$ flask run
+```
+
+use `flask-restx`' swagger dashboard to test APIs, or alternatively use `postman`
+
+
+## Project Structure
+
+```bash
+api-server-flask/
+├── api
+│   ├── config.py
+│   ├── __init__.py
+│   ├── models.py
+│   └── routes.py
+├── Dockerfile
+├── README.md
+├── requirements.txt
+├── run.py
+└── tests.py
+```
+
+
+## Modules
+
+This application uses the following modules
+
+ - Flask==1.1.4
+ - flask-restx==0.4.0
+ - Flask-JWT-Extended
+ - pytest
+
+
+## Testing
+
+Run tests using `pytest tests.py`

api/__init__.py

@@ -3,21 +3,15 @@
 Copyright (c) 2019 - present AppSeed.us
 """
 
-import os
-import re
-from datetime import datetime, timedelta, timezone
-
-from flask import Flask, request, jsonify, make_response
-from flask_jwt_extended import JWTManager, jwt_required, get_jwt, create_access_token, get_jwt_identity
-from flask_restx import Api, Resource, marshal, fields, abort
-from flask_sqlalchemy import SQLAlchemy
-from werkzeug.security import generate_password_hash, check_password_hash
+from flask import Flask
 
+from .routes import rest_api, jwt
+from .models import db
 
 app = Flask(__name__)
 
-app.config.from_object('api.config.Config')
+app.config.from_object('api.config.BaseConfig')
 
-db = SQLAlchemy(app)
-api = Api(app)
-jwt = JWTManager(app)
+db.init_app(app)
+rest_api.init_app(app)
+jwt.init_app(app)