HexTech - Technology Solutions

HexTech is a fictitious technology company created by students from the 4th Semester of Database at Fatec SJC - Prof. Jessen Vidal to complete their coursework and semester API project. We specialize in software development, database management, and technological innovation.

Table of Contents

• About HexTech
• Project Purpose
• Getting Started
• Sprint Timeline and Backlog
• Development Tools
• Team Members

About HexTech

We are a fictional company, developing semester projects during our graduation in Database at Fatec. These projects are API (Learning by Integrated Projects). The current members of the group are listed in the README.md at the end.

Project Purpose

Our project purpose is to develop an Aircraft Configuration Control (ACC) system for Embraer, the Brazilian Aeronautics Company. Embraer is responsible for manufacturing military, commercial, executive, and agricultural aircraft. As the third-largest company in the world in executive aviation, Embraer is gradually reducing the dominance of European and American companies in the sector. With the ACC, Embraer will be able to manage and control the configuration of its aircraft, providing an efficient and effective solution to optimize their production process. The system will allow pilots to check the configuration of the aircraft they are flying, compare the items present, and know if there are Follow-on-Limitations (FOLs) for them, thus ensuring dispatch quality.

Presentation of the wireframe for each proposal:

Getting Started

To begin working on this project, you'll need to follow these steps:

1. Clone this repository by running git clone https://github.com/GroupHextech/HEXTECH-API4sem.git in your terminal.
2. Download the necessary submodules by running git submodule update --init --recursive.
3. Install the dependencies for each submodule separately. This project is divided into three submodules: acc-frontend, acc-backend, and acc-documentation.

Prerequisites

Before you start, make sure you have the following installed:

• Node.js and npm (for acc-frontend)
• Java 11 or higher (for acc-backend)
• Maven (for acc-backend)

Installing

To install the necessary dependencies for each submodule, navigate to the submodule directory and run the following commands:

acc-frontend:

• The frontend is made with Vue.js and Typescript, and it is initialized by Vite. To get started with the frontend, navigate to the acc-frontend directory and run the following command:

# Navigate to acc-frontend directory
cd acc-frontend

# Install dependencies
npm install

acc-backend:

• The backend is made with Springboot and has some dependencies such as Maven and other Spring Framework dependencies, and Lombok is also used. To get started with the backend, navigate to the acc-backend directory and run the following command:

# Navigate to acc-backend directory
cd acc-backend

# Install dependencies
mvn install

acc-documentation:

• The documentation module contains the documentation of the API endpoints. To access the documentation, navigate to the acc-documentation directory and open the index.html file in your web browser.

# Navigate to acc-documentation directory
cd acc-documentation

# Install dependencies
npm install
npm install --global yarn
yarn install

Running

Each submodule has its own instructions on how to run it:

acc-frontend:

# Navigate to acc-frontend directory
cd acc-frontend

# Start the development server
npm run dev

acc-backend:

# Navigate to acc-backend directory
cd acc-backend

# Start the Springboot application
mvn spring-boot:run

acc-documentation:

# Navigate to acc-documentation directory
cd acc-documentation

# Start the documentation server
yarn dev

By following these steps, you should be able to run each submodule independently and start working on your project. Good luck!

User's Manual (Excuting the application)

Manual with all the steps to run the desktop application. User's Manual

Sprint Timeline and Backlog

Sprint 1 - (13/03 - 02/04)

• Database modeling
• Login page
• Chassis page
• Database normalization

Sprint 2 - (03/04 - 23/04)

• Creating a database in the Oracle cloud
• Backend integration with the database
• Insertion of chassis and service bulletins in the database via .csv file
• List of items and chassis

Sprint 3 - (24/04 - 14/05)

• User authentication
• SB change log
• Service Bulletin status update
• List of chassis by item
• Chart with the service bulletins status by chassis
• Application installation guide

Sprint 4 - (15/05 - 04/06)

• Registration of items and formulas
• Adjust methods according to permissions
• Security configuration
• Chart with available items by chassis
• Chart with the number of chassis with a specific service bulletin
• User manual
• Documentation of API endpoints and frontend components
• FAQ

Development Tools

Frontend:

Backend:

Database:

Team Members

Photo	Name	Function	Links
	Danilo Verginio	Product Owner
	Michel Rubens	Scrum Master
	Luiz Borges	Developer
	Victor Fernandes	Developer
	William Antoniazzi	Developer

⬆ Back to Home