Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 2.09 KB

README.md

File metadata and controls

87 lines (55 loc) · 2.09 KB

SpiritSearch

Introduction

SpiritSearch is a web application designed to help users discover new cocktail recipes. Built with React and Next.js, it offers a simple yet powerful way to explore a wide range of cocktail options without the need for a fully stocked bar. It uses the TheCocktailDB API to provide a comprehensive list of cocktails and ingredients. Users can search for cocktails by name, category, glass type, or alcholic content.

Features

  • Search for cocktails by name, category, glass type, or alcoholic content
  • View detailed information about each cocktail, including ingredients and instructions
  • Dive into individual ingredients to see what other cocktails they are used in
  • Save cocktails to a favorites list for easy access
  • View a random cocktail for inspiration
  • Responsive design for mobile, tablet, and desktop

Live Demo

Check out SpiritSearch live: https://spirit-search.vercel.app/

Getting Started

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

Prerequisites

npm

npm install npm@latest -g

Installation

Clone the repo

git clone https://github.com/pdiegel/Spirit-Search.git

Install NPM packages

npm install

Add this Environment Variable to a .env file in the root directory:

# This is required for development purposes.
NEXT_PUBLIC_NODE_ENV=development

Usage

After installation, you can run SpiritSearch locally:

npm start

Navigate to http://localhost:3000 to view the app.

Contributing

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

Philip Diegel - [email protected]

Project Link: https://github.com/pdiegel/Spirit-Search

Tech Stack

  • React
  • Next.js
  • Vercel