Project Overview April 21 2020

Project Overview:

GitHub Project Board

Folders Structure:

housinghub
├───.github
│   └───workflows
├───backend
│   ├───alembic
│   │   └───versions
│   ├───docs
│   ├───src
│   │   ├───app
│   │   │   └───templates
│   │   ├───models
│   │   ├───services
│   │   └───test
│   └───venv
│       ├───Include
│       ├───Lib
│       │   ├───site-packages
│       └───Scripts
└───frontend
    ├───public
    └───src
        ├───actions
        ├───api
        ├───components
        ├───containers
        ├───reducers
        └───style

backend folder:

alembic folder: utility for database migrations

usage example:

$ cd backend/alembic  
$ alembic revision -m ‘create foo table’  
Generating /../../..//../.../versions/8238971238712_create_foo_table.py ...done ` 

src folder:

app folder:

flask -> Blueprint

How to define entry points and method handlers:

Serializing and deserializing Python Dictionaries with marshmallow:

API Spec library to autogenerate Swager stuff

Autogenerate marshmallow from SQL using SQLAlchemyAutoSchema

Services for modularizing common functionality like data base interaction, authentication, container, etc :

Authentication @authenticate decorator to simplify the definition of authenticated end points:

frontend folder:

A classic react application with: components and containers (html and js), store (reducers), api (communication with the backend), and style (css)

Entry Point:

Workflow:

Login workflow:

Storage in the browser and place in the code