Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhammedmagdyy/elmenus-technical-task
A REST API for Managing Drone Communication.
https://github.com/muhammedmagdyy/elmenus-technical-task
docker java jpa-hibernate mysql spring-boot
Last synced: 7 days ago
JSON representation
A REST API for Managing Drone Communication.
- Host: GitHub
- URL: https://github.com/muhammedmagdyy/elmenus-technical-task
- Owner: MuhammedMagdyy
- Created: 2023-12-16T18:41:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-16T23:46:05.000Z (about 1 year ago)
- Last Synced: 2023-12-17T23:55:33.433Z (about 1 year ago)
- Topics: docker, java, jpa-hibernate, mysql, spring-boot
- Language: Java
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Drone Communication Task
[](https://www.java.com/)
[](https://spring.io/projects/spring-boot)
[](https://www.mysql.com/)
[](https://www.docker.com/)
## Table of Contents
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Features](#features)
- [Schema](#schema)
- [API Documentation](#api-documentation)
- [Setup](#setup)
## Introduction
There is a major new technology that is destined to be a disruptive force in the field of transportation: **the drone**. Just as the mobile phone allowed developing countries to leapfrog older technologies for personal communication, the drone has the potential to leapfrog traditional transportation infrastructure.
Useful drone functions include the delivery of small items that are (urgently) needed in locations with difficult access.
## Prerequisites
- A text editor (e.g. IntelliJ IDEA Ultimate `recommended`, Eclipse)
- A platform for testing APIs like [Postman](https://www.postman.com/downloads/)
## Features
1. Register a Drone.
2. Load Drone with Medication Items.
3. Check Loaded Medication Items.
4. Check Available Drones for Loading.
5. Check the Drone Battery Level.
## Schema
## API Documentation
### Postman
Explore and test the API using the provided Postman collection. Click the "Run in Postman" button below to import the collection into your workspace collections.
**Don't forget to choose the `Dron-Task` environment from `No Environment` located in the top-right corner**
[
](https://app.getpostman.com/run-collection/10107969-81173bb4-353f-4f85-8100-faa82e5bce6b?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D10107969-81173bb4-353f-4f85-8100-faa82e5bce6b%26entityType%3Dcollection%26workspaceId%3Da89d13d1-ccf8-4dbe-8d4d-f8a6b1c4c2dc#?env%5BDrone-Task%5D=W3sia2V5IjoiQkFTRV9VUkwiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0In1d)
### Swagger
Use the Swagger UI to explore the available endpoints, view request/response examples, and even test the API interactively.
1. Run the application.
2. Open your web browser and go to `http://localhost:{PORT}/swagger-ui.html` to view the Swagger documentation.
**Replace `PORT` with the actual port number if your application uses a different one.**
## Setup
To run the Spring Boot application locally, make sure you follow these steps:
1. Clone the repository
```bash
https://github.com/MuhammedMagdyy/elmenus-technical-task.git
```
2. Change the project's directory
```bash
cd elmenus-technical-task
```
3. The application uses MySQL as its database. Make sure to set up your MySQL database. **Feel free to use your data source**. Here are my configurations in the `application.properties` file
```bash
# Database Configuration
spring.datasource.url=jdbc:mysql://localhost:3306/{database name}
spring.datasource.username=
spring.datasource.password=
# Hibernate Configuration
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialect
# Logging Configuration
logging.level.org.springframework.web=DEBUG
```
4. Press run and let the magic happen! 🤩