Skip to content

README.md

Latest commit

 

History

History
63 lines (45 loc) · 1.63 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.63 KB

W24-SENG-401-Project

Welcome to Yes Chef ! This README.md file provides you with instructions on how to set up, run, and access the application, how this app is deployed, as well as an overview of the project's design.

URL to application

https://w24-seng-401-project-final.vercel.app

Table of Contents

Design

  • Data privacy: Data is kept private by encrypting sensitive user information
  • Ease of use: The application is very easy to use, with an intuitive GUI and helpful text prompts throughout the application. The app requires minimal training, so anyone can use it.
  • User authentication: Only authenticated users can access this application

Installation

Here are the instructions to get the code working locally.

Prerequisites:

Installation

  1. Clone the repository
git clone https://github.com/maheen-raza/W24-SENG-401-Project.git
  1. Install and run locally
  • Front end Note: Please contact author for required .env file as the frontend will not run without it
cd yeschef
cd frontend
yarn install
yarn dev
  • Backend Note: Please contact author for required .env file as the backend will not run without it
cd yeschef
cd backend
yarn install
yarn add sharp --ignore-engines
yarn dev

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT