Giter Club home page Giter Club logo

openbrewerydb-java-api's Introduction

openbrewerydb-java-api

Dependencies

  • Java 16 (See SDKMan for JDK management)
  • Gradle
  • Docker
  • Docker Compose

Getting Started

Quick

The run script will build the app, dockerize it, and deploy to docker compose automatically.

./run_it.sh

Manual

  • Run ./gradlew clean build to build the .jar locally.
  • Dockerize it with docker build ..
  • Substitute the tag in the docker.compose.yml file and run docker-compose up -d to deploy it locally.

Useful Docker Commands

  • docker-compose ps - Shows which docker containers are running.
  • docker logs -f openbrewerydb - Shows the server logs.
  • docker-compose stop - Stops all containers
  • docker-compose up - Starts all containers, or restarts if there were changes.

Running Dependency Analysis

We can run a dependency check analysis that will show us vulnerabilities. This command will start the analysis:

./gradlew dependencyCheckAnalyze

This will output an HTML and JSON file in the /build/reports/ directory.

openbrewerydb-java-api's People

Contributors

chrisjm avatar johnnyk737 avatar noebrito avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

openbrewerydb-java-api's Issues

Add /brewery query params

We would like to add some query params that match the rails-api

  • by_country: /breweries?by_country=scotland
  • by_city: /breweries?by_city=san_diego
  • by_name: /breweries?by_name=almanac
  • by_state: /breweries?by_state=california
  • by_type: /breweries?by_type=micro
  • by_postal: /breweries?by_postal=44107
  • by_ids: /breweries?by_ids=1,2,3
  • by_dist: /breweries?by_dist=38.8977,77.0365
  • exclude_types: /breweries?exclude_types=micro,nano

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.