AccessibleCooking

A repository for Chef's Touch, a prototype recipe website for people who are visually impaired.

Heroku app: https://chefstouch.herokuapp.com/

Documentation website: https://arianaolson419.github.io/AccessibleCooking/

Installation

Working on this project requires some amount of set up. To start, fork and clone this repository. There are some dependencies to install afterwards.

MongoDB

Install MongoDB. Use these instructions. On macOS with Homebrew installed, you can instead run brew install mongodb.

sudo service mongod start to run the database locally

Pipenv

For local development, pipenv is a good tool. To install,

pip install pipenv

Then change to the desired directory (in this case, AccessibleCooking).

cd AccessibleCooking
pipenv install
pipenv shell

This should create a virtual environment with all dependencies installed, then launch the environment. To exit,

deactivate

This guide to pipenv may help debug any issues.

Flask

Flask should be installed when the pipenv is created. See this overview of Flask if there are any difficulties.

MongoAlchemy

Flask-MongoAlchemy should be installed with the pipenv. It provides an easy interface with the mongoDB. This MongoAlchemy documentation site provides an overview.

Set up Heroku App

Follow startup instructions for Heroku.

Link a database in mLab to your Heroku app.

Recipe and Tip Contribution

Read style_guide.md before contributing content to Chef's Touch. Recipes and tips are intended to be for the visually impaired by the visually impaired or career specialists.

Built With

Skeleton CSS templates

Flask MongoAlchemy