Documentação do negócio
Documentação técnica
Configurações do Projeto
Descrição
Esta seção é destinada para apresentação das tecnologias utilizadas pelo time e orientações de como configurar e rodar o Frontend e o Backend.
Configurações Gerais
Aqui serão encontradas informações das tecnologias utilizadas para o desenvolvimento do projeto e as instruções de configuração de ambos ambientes de desenvolvimento.
Tecnologias utilizadas
Frontend
Node Js Version: 20.11.1 More information to download: Download Node
$ npm install -g @angular/cli
Backend
Configurando o Backend
Prerequisites
Before installing and running this project, ensure you have the following prerequisites:
- Java: Make sure you have Java installed on your system. You can download and install Java from here.
- Maven: Maven is used as a build automation tool for Java projects. Make sure you have Maven installed. You can download and install Maven from here.
- Docker Desktop: Ensure you have Docker Desktop installed on your system. Docker Desktop provides an easy-to-install application for Docker Engine, Kubernetes, and other tools. You can download and install Docker Desktop from here.
Installation
-
Clone the repository:
git clone https://tools.ages.pucrs.br/ensportive/ensportive-backend.git
-
Navigate to the project directory:
cd ensportive-backend
-
Build the project using Maven:
mvn clean install
Usage
-
Create the Docker volume (only need to be done the first time):
docker volume create ensportive-db
-
Run the Docker compose file:
docker compose up
-
Run the application:
mvn spring-boot:run
This will start the backend server.
-
The backend server will be accessible at http://localhost:8080.
Configurando o Frontend
Prerequisites
Before installing and running this project, ensure you have the following prerequisites:
Angular: Ensure you have Angular installed on your system. This project requires Angular version 17. You can install Angular CLI version 17 by running the following command:
npm install -g @angular/cli@17
Installation
-
Clone the repository:
git clone https://tools.ages.pucrs.br/ensportive/ensportive-frontend
-
Navigate to the project directory:
cd ensportive-frontend
-
install the dependencies:
npm install
Usage
-
Run the Angular application:
ng serve
-
The application will be visible on the port that the terminal will show