babanila / beer-app

beer-app

Table of Contents

• Features
• Requirements
• Usage

Features

• List of all beers
• Details of a single beer

Requirements

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. MacOS and Linux machines typically have this already installed.

• Node.js - Download & Install Node.js and the npm package manager. Make sure to get the latest active LTS version.

• A web browser (e.g. Google Chrome, Mozila, Firefox e.t.c).

• Download the beer-app from this link or download directly using either

  • git clone [email protected]:Babanila/beer-app.git (SSH link)
  • git clone https://github.com/Babanila/beer-app.git (HTTPS link)

• Sandbox Key -

  • Register at https://www.brewerydb.com/ to obtain a Sandbox Key that will be used to run the beer-app.
  • On the https://www.brewerydb.com/ website, after registration.
  • Click on the Developers tab and select My API Keys.
  • Agree on the terms of usage and proceed.
  • Copy the Sandbox Key shown.

How to start beer-app

• Go to your computer terminal (command-line interface).
• Locate the downloaded beer-app folder.
• Change the directory to the beer-app folder(e.g cd beer-app).
• Run yarn install.
• Change to the src folder(e.g cd src).
• To start the server, run node server.js on your terminal.
• Open a new computer terminal.
• Locate the downloaded beer-app folder.
• Change the directory to the beer-app folder(e.g cd beer-app).
• Run yarn start.

Usage

To run the app, follow the steps below.

• Enter the sandbox key on the web page generated after you start the beer-app at the location (e.g http://localhost:3000).
• Click on submit button to get the list of beers.
• To get the full details of a particular beer, kindly click on the beer.
• You can use the back button at the bottom of the page to go back to the previous page.

Note:

- Start the server before running `yarn start` (See above for details).
- You can also use `npm start` to start the beer-app.