/Learn2Cook

Full Stack Application Which provides recipes to beginning cooks.

Primary LanguagePython

Learn2Cook

Is a full-stack application that draws inspiration from New York Times Cooking and Netflix.

As more and more people are learning to be more experimental in their culinary prowess, there should be a website that is dedicated to those who are just starting to learn. Users can look at recipes, read and leave reviews, as well as favoriting what they love to make, for easier access to them!

More information can be found on this project at it's Wiki


Logo

Learn2Cook

A Beginner's Cooking Community
Explore the docs »

Table of Contents
  1. About The Project
  2. Live Link To Project
  3. Demonstration of Project
  4. Getting Started
  5. License
  6. Contact


About The Project

A full stack application that draws inspiration from New York Times Cooking and Netflix.

As more and more people are learning to be more experimental in their culinary prowess, there should be a website that is dedicated to those who are just starting out to learn. Users can look at recipes, read and leave reviews, as well as favoriting what they love to make, for easier access to them!



Live Link

Live Link For This Project Can Be Found Here





Built With



Python

Python

SQLAlchemy

SQlAclehemy

Javascript

Javascript

Flask

Flask

PostGresSQL

Postgres

React

React


Redux

Redux

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/nikhilmenon2/Learn2Cook

  2. Install NPM packages in /reactapp folder

    npm install

  3. Install Pipenv Dependencies in root folder

      pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

  4. Create a .env file based on the example with proper settings for your development environment

  5. Setup your PostgreSQL user, password and database and make sure it matches your .env file

  6. Get into your pipenv, migrate your database, seed your database, and run your flask app

    pipenv shell
    flask db upgrade
    flask seed all
    flask run

  7. To run the React App in development, checkout the README inside the react-app directory.

IMPORTANT! If you add any python dependencies to your pipfiles, you'll need to regenerate your requirements.txt before deployment. You can do this by running:

pipenv lock -r > requirements.txt

ALSO IMPORTANT! psycopg2-binary MUST remain a dev dependency because you can't install it on apline-linux. There is a layer in the Dockerfile that will install psycopg2 (not binary) for us.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Email - nikhilmenon@comcast.net

Project Link: GitHub Project Link