Skip to content

Commit 01da6f0

Browse files
committed
docs: update README.md
1 parent 80cb5c1 commit 01da6f0

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

README-pt-br.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ O iStudy é uma plataforma web projetada para ajudar estudantes a organizar, ger
4141
- `istudy-app`: Esta pasta contém o código do front-end da aplicação, desenvolvido com TypeScript, React.js e NextJS.
4242
- `istudy-services`: Esta pasta contém o back-end do sistema (Java/Spring Boot), que segue uma arquitetura de microsserviços utilizando o Spring Cloud API Gateway como interceptador de requisições para aplicar filtros de autenticação, Spring Cloud Netflix (Eureka) para registro e descoberta de serviços e RabbitMQ como broker de mensagens para comunicação assíncrona entre os microsserviços.
4343
- Toda a aplicação se encontra containeirizada com o Docker.
44+
- Além disso, um pipeline de CI foi implementada para atualizar automaticamente as imagens dos containers e enviar para o Docker Hub sempre que ocorrer uma modificação no branch principal (main).
4445

4546
</br>
4647

@@ -148,7 +149,14 @@ git clone https://github.com/ABeatrizSC/istudy.git
148149
cd istudy
149150
```
150151

151-
3. **Construa e inicialize o container docker**
152+
3. **Adicione sua JWT KEY**
153+
- Crie um arquivo ```.env``` na raiz do projeto e adicione sua JWT KEY a ser utilizada na assinatura do token. Exemplo:
154+
155+
```.env
156+
JWT_KEY=SUA_CHAVE_AQUI
157+
```
158+
159+
4. **Construa e inicialize o container docker**
152160
```bash
153161
docker-compose up --build
154162
```
@@ -1432,4 +1440,4 @@ Account deleted successfully!
14321440
# Contato
14331441
* GitHub: [ABeatrizSC](https://github.com/ABeatrizSC)
14341442
* Linkedin: [Ana Beatriz Santucci Carmoni](www.linkedin.com/in/ana-carmoni)
1435-
* Email: [anabeatrizscarmoni@gmail.com](mailto:anabeatrizscarmoni@gmail.com)
1443+
* Email: [anabscarmoni@gmail.com](mailto:anabscarmoni@gmail.com)

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ iStudy is a web platform designed to help students organize, manage, and track t
4141
- `istudy-app`: This folder contains the front-end code of the application, built with TypeScript, React.Js and NextJS.
4242
- `istudy-services`: This folder contains the back-end of the system (Java/Spring Boot), which follows a microservices architecture using Spring Cloud API Gateway as a request interceptor to apply authentication filters, Spring Cloud Netflix (Eureka) for service registration/discovery and RabbitMQ as a message broker for asynchronous communication between microservices.
4343
- The entire application is containerized with Docker.
44+
- In addition, a CI pipeline was implemented to automatically push images to Docker Hub whenever a modification occurs in the main branch.
4445

4546
## System Architecture
4647
![alt text](docs/images/istudy_architecture.png)
@@ -147,7 +148,14 @@ git clone https://github.com/ABeatrizSC/istudy.git
147148
cd istudy
148149
```
149150

150-
3. **Build and initialize the docker container**
151+
3. **Add your JWT KEY**
152+
- Create a .env file at the root of the project and add your JWT KEY to be used for signing the token. Example:
153+
154+
```.env
155+
JWT_KEY=YOUR_KEY_HERE
156+
```
157+
158+
4. **Build and initialize the docker container**
151159

152160
```bash
153161
docker-compose up --build
@@ -1430,4 +1438,4 @@ All error responses follow the format below:
14301438
# Contact
14311439
* GitHub: [ABeatrizSC](https://github.com/ABeatrizSC)
14321440
* Linkedin: [Ana Beatriz Santucci Carmoni](www.linkedin.com/in/ana-carmoni)
1433-
* Email: [anabeatrizscarmoni@gmail.com](mailto:anabeatrizscarmoni@gmail.com)
1441+
* Email: [anabscarmoni@gmail.com](mailto:anabscarmoni@gmail.com)

0 commit comments

Comments
 (0)