Code Monkey home page Code Monkey logo

whisper-backend's Introduction

Whisper Backend

A considerate microblogging-api built with Springboot. Core backend service.

Installation

Setup

Get Postgres up and running, create a new database, for example whisper_backend. Make sure you have an instance of whisper-auth running to obtain authentication tokens.

Tip: Use whisper-compose to get the full stack up and running quickly.

Environment

The following env vars can be set to affect the behaviour of the system:

DATASOURCE_URL=jdbc:postgresql://localhost:5432/whisper_backend
DATASOURCE_USERNAME=postgres
DATASOURCE_PASSWORD=postgres
SERVER_PORT=9092
SPRING_PROFILES_ACTIVE=dev

Usage

The Maven profile will run the application in dev mode on the default port 9091:

$ ./mvnw spring-boot:run

To on an alternative port (e.g. if compose is already hogging the default port):

$ SERVER_PORT=19091 ./mvnw spring-boot:run

To on another profile:

$ SPRING_PROFILES_ACTIVE=test ./mvnw spring-boot:run

Health check endpoint:

$ curl localhost:9091/actuator/health && echo
{"status":"UP"}

Docker

The dockerfile-maven-plugin doesn't seem to play nicely with newer Docker versions on macOS. Since docker-client is inactive, this looks unlikely to be fixed.

We're providing a simple Makefile instead:

$ make clean docker-build
$ make clean docker-push

API Usage

See API Docs

whisper-backend's People

Contributors

joerx avatar

Watchers

James Cloos avatar  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.