jennifertakagi/whats-in-your-bar

Discover which drink to make with all you have on your bar!

What`s in your bar?

Discover which drinks you can make with the ingredients that are on your bar!
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. License
7. Contact

About The Project

An application to discover which drinks you can make with the ingredients that are on your bar.

Features:

• Select all ingredients that are on you bar
• Discover which drinks you can make with this ingredients -
• Discover which drinks you can make with this ingredients but not limit the search
• Discover a random drink today!

Built With

• React JS
• Node JS
• MongoDB
• Mongoose

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/whats-in-your-bar.git

2. Install packages in api and client folders

   yarn | npm install

3. Run the following command in api and client folder start the application in a development environment:

   yarn start | npm run start

Usage

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be 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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Check out the demo project