Take My Recipe

Take My Recipe

A platform to collect and share everyone’s best recipes!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. Contact
6. Acknowledgements

About The Project

Take My Recipe is an web application built entirely from JavaScript which has a couple of cool features. It's main purpose is to allow users to add recipe for others users to see and try it out. User have the ability to add their own recipe or... try someone elses. User will also have the ability to comment on the recipes of their choosing.

Built With

• Node.js and Express.js
• Handlebars.js
• MySQL
• Sequelize ORM
• HTML
• CSS
• uiKit
• JavaScript

Requirements

• Use Node.js and Express.js to create a RESTful API.
• Use Handlebars.js as the templating engine.
• Use MySQL and the Sequelize ORM for the database.
• Have both GET and POST routes for retrieving and adding new data.
• Have a polished UI.
• Be responsive.
• Interactive (i.e., accept and respond to user input).
• Have a folder structure that meets the MVC paradigm.
• Include authentication (express-session and cookies).
• Potect API keys and sensitive information with environment variables.

Getting Started

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

Installation

1. Clone the repo

   git clone https://github.com/schaudhary1/take-my-recipe.git

2. Install NPM packages

   npm install

3. Start your Server

   npm run nodemon 

4. Go your browser and type in the URL the following:

   http://localhost:#ADD PORT NUMBER HERE

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

1. Login or Signup

2. Add your recipe

3. Checkout your created recipe

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Shital Chaudhary Shitalchau10@gmail.com

Project Link: https://github.com/schaudhary1/take-my-recipe

Acknowledgements

• Jaya Gudipalli
• Conner Werth
• Shital Chaudhary