An open API service indexing awesome lists of open source software.

https://github.com/spartee/movement-vitamins-web

A web application and API for the Movement Vitamins project
https://github.com/spartee/movement-vitamins-web

Last synced: about 1 year ago
JSON representation

A web application and API for the Movement Vitamins project

Awesome Lists containing this project

README

          

## Overview

The web interface for the Movement Vitamins application.

## How to Run (Development)

1. Create the Dockerfile for the postgres service

- % cd ./flask_recipe_app/web/
- % python create_postgres_dockerfile.py
- % cd ..

2. Build and run the Docker containers

- % docker-compose build
- % docker-compose up -d

3. Create or re-initialize the database

- % docker-compose run --rm web python ./instance/db_create.py

To view in the web run

- % docker container ls

and then type the address of the flask app into a web browser of your choosing

## Key Python Modules Used

- Flask - web framework
- Jinga2 - templating engine
- SQLAlchemy - ORM (Object Relational Mapper)
- Flask-Bcrypt - password hashing
- Flask-Login - support for user management
- Flask-Migrate - database migrations
- Flask-WTF - simplifies forms
- itsdangerous - helps with user management, especially tokens

This application is written using Python 3.6.1. The database used is PostgreSQL.

Docker is the recommended tool for running in development and production.

## Unit Testing

In the top-level folder:
% nose2

## TODO

- create models for database in web/project/models.py (done)
- create a script for creating postgresDB in web/instance/create_db.py (done)
- change API to give and take user movement vitamin data (done)
- remove recipe templates and add in davids templates (done)
- create superuser and superuser views (for Cory) (change admin view)
- banners for site
- thumbnails for youtube api