Giter Club home page Giter Club logo

fuel-filling-service's Introduction

fuel-filling-service Demo Build Status

A helidon (microprofile) RESTful webservice with microstream.

The project represents a basic CRUD webservice where you can manage fuel fillings (of a car).
It is also shipped with a nice UI (openapi-ui) so that no external REST/HTTP client is required.

Used technologies

Documentation about this project is available here

The demo is hosted on heroku.
It may take some seconds to start.

openapi-ui screenshot

Download Release Status

There are prebuilt executables, so that you don't have to build the code locally.

JAR

Docker Latest docker version Develop docker version

  • Run the latest release using docker run --rm -p 8080:8080 --name fuel-filling alb2k/fuel-filling-service
  • Stop/Remove it with docker stop fuel-filling
  • Open http://localhost:8080

Building / Executing it locally

If you don't want to use the prebuilt executables you can also build the project.
You can either build and execute this project IDE-based or directly with Java or Docker.

IDE

Requirements (the IDE should contains these functions):

  • Java 11
  • Maven 3

Run it

  • Build the project with mvn clean package
    NOTE: Normally this is not required, but it should be done when you wish to update the openapi file
  • Start/Debug the project by invoking io.helidon.microprofile.cdi.Main

Java/JAR

Requirements:

  • Java 11
  • Maven 3

Building the JAR

  • Build the project with mvn clean package
  • Run the built jar with java -jar target/fuel-filling-service.jar
  • Open http://localhost:8080

Docker

Requirements:

  • Docker

Building and running it

  • Build the image with docker build -t fuel-filling .
  • Execute it with docker run --rm -p 8080:8080 --name fuel-filling fuel-filling
  • Stop/Remove it with docker stop fuel-filling

Dependencies and Licenses dependency overview Apache License 2.0

For the license of this project, check the LICENSE file
A summary of all dependencies and their licenses is also available online

This project was created for the Microstream hackathon

fuel-filling-service's People

Contributors

alb2k avatar dependabot[bot] avatar

Watchers

 avatar

fuel-filling-service's Issues

Add docs

Add docs for:
Overview:

  • Overview

Details:

  • Helidon
  • Microstream
  • OpenAPI (+UI)
  • Logging
  • GitHub Actions
  • Heroku (with GitHub)

Other:

  • Final review
  • Spell check

Build Docker-Images and publish them

Build docker images and publish them (to GitHub or DockerHub):

  • "Normal" Image
  • jlink-image (was not working; may be fixed first)
  • native-image (was not working; may be fixed first)

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.