GithubHelp home page GithubHelp logo

cjohansen11 / brewdb Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 7.83 MB

Full stack project to display breweries around the world

Dockerfile 1.46% Shell 0.45% TypeScript 95.33% JavaScript 2.52% CSS 0.24%

brewdb's Introduction

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 [email protected]: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

brewdb's People

Contributors

cjohansen11 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.