Giter Club home page Giter Club logo

fridge-magican's Introduction

fridge-magican

License

Not Applicable

Description

This application allows the user to determine what recipes they can make with the ingredients stored within their fridge. The application uses a mysql database to provide recipe information to the user, and allows the user to change the ingredients within their fridge from valid ingredients stored in the database.

The application has login and logout functionality to allow various users to store different fridge ingredient sets.

Table of Contents

  1. Installation
  2. Usage
  3. Collaborators
  4. Contribution Guidelines
  5. Tests
  6. Questions

Installation

Once cloned, navigate to the relevant directory and run the following command to install project dependencies:

npm i

Note: You must have node and mysql installed on your machine for this application to function.

Log in to mysql and run the following command to initiate the database:

source db/schema.sql

Usage

To run the application on your local machine, complete the installation process then navigate to the relevant directory and run the following command in the console:

npm start

The application also relies on seed data to explore all functions. Seed data can be populated by running the following command in the terminal:

npm run seed

Note that the server must be run at least once for the seed data to be populated as the initial run of the server will generate the database tables.

Collaborators

The following personnel have been involved in the devleopment of this application:

  • Craig Skicko
  • Freddie Yang
  • Artur Aleksanyan
  • Patrick Gu

Contributing

To contribute to the ongoing success of this application, please fork a repository then create a pull request once all relevant changes have been implemented and the updated code has been thoroughly tested

Tests

At the time of writing, no specific tests have been written for this repository. If contributing, prior to pushing changes to the main branch, please ensure that updated code has been thoroughly tested.

Questions

Should you have any questions, please contact me via GitHub or by email

fridge-magican's People

Contributors

cskicko avatar artur0705 avatar dark40 avatar patrickthegu avatar

Watchers

 avatar

Forkers

artur0705

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.