Giter Club home page Giter Club logo

group1-project2-recipe's Introduction

Module 3 Project Proposal & Scopes:

My Cooking-Recipes Web App

A web app that allows registered user to keep their secret recipes online which allow user to key their recipes with images.

  • allow user to list the
    • ingredients,
    • cooking methods,
    • utensils required
    • relevant images on a persistent storage.
  • user can edit/delete all their above inputs with date-stamp.
  • categorization of their recipes store
    • SEAsian/Oriental/Western
    • Dish types (Starter/Main/Desert/Beverage/Bakeries).

Type of integration required:

  • React-JS frontend + node-JS backend
  • Registration as verified user (name, email address and password)
  • Heroku PostgreSQL (Database for users registration & login, Database for recipes storage + images)
  • Server-less Deployment on Heroku

Backend Layers

Scopes of work:

  • Software System Architecture => Leslie (Thursday 3/3) DONE
    • Use Case UML diagrams
    • Use Case Scenario UML diagrams
    • ERD digrams => Keith/Mani DONE (7/3)
  • Git integration => CP, Leslie
  • MVC framework - nodeJS => Leslie
  • ReactJS UI frontend => CP
  • Authentication - Cookies/Session - passport.js & express-session: => Liew/Leslie
  • ORM-Sequelize + HerokuPostgres (refer to ERD) => Mani, Keith
  • Heroku Deployment.

Use Cases

ERD Update by Keith

ERD Keith

Technologies used:

  • nodeJS
  • ExpressJS
    • Middleware
    • Routing
    • Cookies & Session // not use
  • SequelizeJS
    • ORM
    • Queries
  • Application Security (Passport, Bcrypt & JWT) -
    • Authentication
    • Passport.js session // not use
  • Model View Controller Architecture
Project structure:
- client/
  - src 
    - index.js 
- server/
  - controllers/
    - userController.js
    - recipeController.js
  - models
    - index.js
    - ingredient.model.js
    - receipe_ingredient.model.js
    - recipe.model.js
    - user.model.js
  - routes
    - index.js
    - loginRoutes.js
  - services
    - userService.js
    - recipeService.js
  - index.js

Required End-points

  • User-login
    router.route("/register") // priority Liew/Leslie
    router.route("/login") // priority Leslie
    router.route("/logout") 
    router.route("/resetpassword") 
    router.route("/deleteUser")
  • Recipe
    router.route("/recipe/showIngredient") // priority Mani
    router.route("/recipe/showRecipe") // priority Mani
    router.route("/recipe/add") // user.isAuthenticated() // priority CP
    router.route("/recipe/edit/:recipeId") // user.isAuthenticated() // priority CP
    router.route("/recipe/delete/:userId") // user.isAuthenticated() // priority Keith
    router.route("/search") // Charles

Heroku access

Heroku postgres db setup in progress, users table done. Herewith the steps to connect to it from your local.

  1. open terminal
  2. heroku login
  3. press any key open browser then key in credentials. Email: [email protected] Password: ch3@group1
  4. heroku pg:psql postgresql-amorphous-45283 --app ecookbook

group1-project2-recipe's People

Contributors

manirajantu avatar cpwong avatar ktxjl avatar lesliechiang avatar edisonzsq avatar

Stargazers

 avatar

Watchers

Chewy K avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.