RecipeHunter

A recipe management application for busy people
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This is a quarter-long final project of the CSE110 course taught at UC San Diego. Team-6 aka. Productive Raccoons, have been working hard to deliver a user-centric recipe-management-application that serves quick and easy-to-make recipes for people short on time or on a tight budget.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example 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/Dzhango/cse-110-team-6

2. Install NPM packages

   npm install

3. Open any page in your browser

   /source/pages

(back to top)

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.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [] Chrome Extension
• [] Adding notes to recipes

See the open issues for a full list of proposed features (and known issues).

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Your Name - @Dzhango - [email protected]

Project Link: https://github.com/Dzhango/cse-110-team-6

(back to top)