Giter Site home page Giter Site logo

springbootapikotlin's Introduction

Api Backend

The CDSC (Custom Driven Supply Chain) is a program aimed at improving logistics processes for inbound, inhouse and outbound. It consist on several tools: Data Integrations, Control Panels, Web applications, Mobile applications

In this repo you can found a basic api, with a mysql and a Swagger documentation where you can try the api methods.

image

How to run with Docker ๐Ÿณ (recommended)

Spin up docker container the first time

$ ./make.sh install

Execute the tests

$ ./make.sh tests

Build and run

$ ./make play

Try the api

http://0.0.0.0:8081/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/

Stop the cointainer

$ ./make down

How to run in local

You need java version 14. and maven installed in your local machine. You can verify the version typing java -version

Set up the docker containers, because you need the mysql database running.

Build

$ mvnw clean package

Run

$ java -jar target/app*.jar

Try the api from local

http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/

To do's

  • Deploy to prod environment ๐Ÿš€
  • Action when team make a PR (Test, coverage, quality...)
  • How deploy can be modified or improved
  • Monitoring ๐Ÿค–
  • Secrets ๐Ÿ™Š
  • Infra as code. How to create an RDS (common code, code inside the project...)

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.