jhorst2020/uncapped

UNCAPP'D

A social app that allows users to drink good Scotch, and tell the world about it.
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
8. Acknowledgements

About The Project

This application allows users to submit Scotch reviews, and give it a rating from 0 to 5 "bottles." The site also allows users to add new bottles of Scotch to the database, and update existing spirits.

Notable Technologies Used

Getting Started

To get a local copy up and running follow these simple 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/JHorst2020/Uncapped.git

2. Install NPM packages

   npm install

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

Jerzy Horst - Portfolio Website: https://jerzy.tech

Project Link: https://github.com/JHorst2020/Uncapped

Acknowledgements

• App Academy
• Best-README-Template