Giter Club home page Giter Club logo

simple-user-api's Introduction

Simple user API

I created this simple user API for my personal contribution to my theses which I had to write for school. It utilizes SpringBoot to host some simple REST endpoints for managing users, which are stored inside a MariaDB database. It also has OpenAPI and SwaggerUI built into it to visualize what it can do.

Getting started

To run this simple API application on your server you only need to follow a few simple steps.
System requirements: A Linux machine with a relatively modern version of docker-compose installed. (If you're running on another OS you might have to adjust some things inside the Dockerfile. For example, for Windows the RUN ./gradlew build has to be changed to RUN ./gradlew.bat build.)

How to get it running

1. Clone this GitHub repository onto your machine by either running:

git clone https://github.com/tillhfm/simple-user-api.git

or downloading the repository manually to your machine.

2. Open up the docker-compose.yml file and change the values of the pre-defined environment variables to hold your database credentials. The user table is being created once the application runs.

3. In your terminal, navigate inside the repository folder and run:

docker-compose build

4. After the process is finished (might take up to a minute), execute:

docker-compose up -d

The application will now be available at http://localhost:8080, given you didn't change any of the port options.
To stop the application, head back to the repository folder and run:

docker-compose down

simple-user-api's People

Contributors

tillhfm avatar

Stargazers

 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.