Giter Club home page Giter Club logo

air-companies-manager's Introduction

Air Companies Management API

A project to comfortable managing many Air Companies, airplanes and flights. You can create companies, operate information about them, move airplanes between companies, monitor expired or overdue flights and so on.

Demo

Video: how to run and test Air Companies Management API?

Swagger UI

Swagger-UI

Postman Collection

Postman-Collection

Tech Stack

Technologies that are used to create an efficient and well-organized environment for the development and management of the Air Companies Management API.

  • Java 11

  • Spring Boot 2.2

  • Spring Data JPA

  • Mapstruct

  • Lombok

  • MySQL

  • Docker

  • Maven

How to run?

This API requires JDK 11 and Docker!!!

If you don't have installed Java 11 or Docker, download it and install:

If you want to run locally this API, you'll need MySQL:

  • Linl to download MySQL: MySQL
  1. Clone the project
$ git clone https://github.com/fedorovychh/air-companies-manager.git
  1. Start your Docker
  2. Open API in Inteliji IDEA
  3. Open resources folder and find an application.properties file. Then specify your MySQL DB password (if you want to run application locally).
spring.datasource.password=${DB_PASSWORD}
  1. Open .env file in root folder and specify your MySQL DB password.
MYSQLDB_ROOT_PASSWORD=root
  1. Run following terminal commands:
mvn clean package

This project is build on maven, so this command deletes target/ folder and creates .jar file, that is necessary for Docker.

docker-compose build
docker-compose up

These commands create image and run docker container.

Wait until next message will be shown:

Started AirCompaniesManagerApplication in 20 seconds
  1. Open browser and follow address: http://localhost:8088/api/swagger-ui.html

Swagger UI added to demonstrate what endpoints does API contain.

To test API properly, please use this Postman Collection.

air-companies-manager's People

Contributors

fedorovychh 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.