An open API service indexing awesome lists of open source software.

https://github.com/iguit0/amazonia

A solution for optimizing drone delivery routes
https://github.com/iguit0/amazonia

study-project

Last synced: 12 months ago
JSON representation

A solution for optimizing drone delivery routes

Awesome Lists containing this project

README

          


Amazonia

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

This monorepository contains both the backend and frontend components of our application, which provides a single, unified codebase for more efficient development and collaboration.

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Get Started](#get-started)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)

## Introduction

Géfersom Bejos, CEO of the large Brazilian e-commerce company *amazônia*, hired [ateliware](https://ateliware.com/en/) to develop a new system responsible for **calculating the fastest delivery route for his new drone system**. Once the starting point, the object collection point, and the delivery point are defined, his drones should, in the shortest time possible, reach their destination.

## Get Started

To clone the repository to your local machine, follow these steps:
1. Open a terminal.
2. Navigate to the directory where you want to clone the repository.
3. Execute the following command:

```shell
git clone https://github.com/iguit0/amazonia.git
```

```bash
cd amazonia
```

### Installation

Once you have cloned the repository, you may need to install the project's dependencies. Follow the instructions below to set up the backend and frontend components.

- [Backend instructions](./backend/README.md)

- [Frontend instructions](./frontend/README.md)

## Contributing

If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING](./CONTRIBUTING.md) file.

## License
This project is licensed under the [MIT License](https://opensource.org/license/mit/). Refer to the [LICENSE](./LICENSE) file for more information.