Skip to content

JRamirezDD/Aerotelcel

Repository files navigation

### Credits:

Application Developed by:
Jorge Ramirez de Diego
Javier Ortega Mendoza
Marcos Gonzalez Fernandez


### Initial Notes

- Ensure that all requirements are met and correctly configured before starting the launch procedures.
- In case you are having issues with any of the described steps, please send an email with a detailed explanation to 'no.reply.aerotelcel@gmail.com' in order to receive assistance.
- Source code is available for download at: https://github.com/JRamirezDD/Aerotelcel


# Application Front-end Setup Guide

This guide is designed to help you set up and launch the front-end of our application quickly and efficiently.

## Requirements

Please ensure you have the following software installed.

- **React JS**

- **React-Router dom v6.22.1**

- **Mapbox Gl v1.13.1**

- **React-mapbox v5.1.1**

- **Back-end Application**
  - All back-end components should be running on their default ports.

## Launch Procedure

To utilize the AeroTelcel app the user must install the following dependencies: React-React-Router-Dom and Mapbox GL. Run the following script in the terminal: “npm install”.
After this, you should run all the back-end services and check out that the services
are working without any problem. Then, position yourself inside the application folder by stating in the terminal:
cd .\Web\\aerotelcel
Finally, run the application script in the terminal:
npm start



# Application Back-end Setup Guide

This guide is designed to help you set up and launch the back-end components of our application quickly and efficiently.
Please follow the steps below carefully to ensure a successful setup.

## Requirements

Before proceeding, ensure you have the following software installed in your system:

- **Java Development Kit (JDK) v17.0.10+7**
  - [Download JDK](https://adoptium.net/temurin/)

- **Docker Desktop v4.28.0**
  - [Download Docker Desktop](https://www.docker.com/products/docker-desktop/)

- **MySQL and Redis Instances**
  - MySQL should be accessible on localhost, port 3306, with root password `password`.
  - Redis should be accessible on localhost, port 6379.

- **Python v3.9.7**
    - [Download Python](https://www.python.org/downloads/)

- OpenSky API
    - Clone the APIs repository from 'https://github.com/openskynetwork/opensky-api'
    - Install the API using the following command:
    - pip install -e /path/to/repository/python
    - consult api documentation for further information

## Launch Procedures

We offer two methods for launching the back-end services: the Default Launch Procedure and the more prone to failure Docker-Compose Launch Procedure.

### Default Launch Procedure

1. **Configure Environment Variables:**
   - Modify the `application.properties` files within each microservice to adjust any environment variables, particularly if your MySQL or Redis configurations differ from the expected configurations.

2. **Launch Services:**
   - Navigate to the project's `DevOps` directory.
   - Build up docker compose for databases,  `docker-compose -f docker-compose-dbservices.yaml up`.
   - For Windows, run `build_all.bat` followed by `run_all.bat`.
   - For Linux, run `build_all.sh` followed by `run_all.sh`.

### Docker-Compose Launch Procedure (Alternative)

1. **Prepare Docker Compose:**
   - Ensure Docker Desktop is installed and running.
   - Directly modify the `docker-compose.yaml` in the `DevOps` directory if you need to adjust environment variables for the microservices.

2. **Launch Services Using Docker Compose:**
   - In the `DevOps` directory, execute the following commands:
     - For Windows, run 'build_all.bat', then execute `docker-compose up --build`.
     - For Linux, run 'build_all.sh', then execute `docker-compose up --build`



About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published