/brewDB

Full stack project to display breweries around the world

Primary LanguageTypeScript

BrewDB

A full stack application to display breweries around the world.

Installation

  • Clone repo:
HTTPS:
    git clone https://github.com/cjohansen11/brewDB.git
SSH:
    git clone git@github.com:cjohansen11/brewDB.git
  • Start Docker either with the Application or CLI - Install Docker
  • Navigate into the brewDB directory cd brewDB
  • Install dependencies yarn
  • Create server .env
  • Create env files - See Environmental Variables section below
  • To start API run:
    docker-compose up
  • Open another terminal tab
  • To start client run:
    yarn dev
  • Navigate to localhost:3000

Environmental Variables

  • Duplicate apps/api/.example.env and rename .env
  • Duplicate apps/next-app/.example.env.local and rename .env.local

Node Variables

To run this project, you will need to add the following environment variables to your apps/api/.env file

    CORS_ORIGIN=http://localhost:3000

NextJS Variables

To run this project, you will need to add the following environment variables to your apps/next-app/.env.local file

To generate the Google API Key go to Create Google API Key

    NEXT_PUBLIC_API=http://localhost:3001
    NEXT_PUBLIC_GOOGLE_API_KEY=

API - Postman

Run in Postman

Acknowledgements

Authors