Skip to content

Commit 7ca19a9

Browse files
author
Gabriel Laureano
committed
Merge branch 'develop'
2 parents bf615c1 + b1d743e commit 7ca19a9

1 file changed

Lines changed: 31 additions & 23 deletions

File tree

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,73 @@
1-
# Garden
1+
# 🌱 Garden
22

33
> Uma Coleção de Notas em Evolução.
44
5-
Repositório para documentação sobre teste e qualidade de software em formato de digital garden.
5+
Repositório de documentação sobre teste e qualidade de software em formato de digital garden. Este projeto utiliza Docusaurus para criar uma base de conhecimento interativa e organizada.
66

7-
[![Docusaurus](https://img.shields.io/badge/Docusaurus-3.7.0-blue?logo=docusaurus&style=for-the-badge)](https://docusaurus.io/)
8-
   
7+
[![Docusaurus](https://img.shields.io/badge/Docusaurus-3.9.2-blue?logo=docusaurus&style=for-the-badge)](https://docusaurus.io/)
8+
  
99
[![CD Workflow](https://img.shields.io/github/actions/workflow/status/gabrioliv/garden/deploy.yml?style=for-the-badge&logo=github)](https://github.com/GabriOliv/garden/actions)
10-
   
10+
  
1111
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fgabrioliv.github.io%2Fgarden&style=for-the-badge&color=1b73ff)](https://gabrioliv.github.io/garden/)
12+
  
13+
[![License](https://img.shields.io/github/license/gabrioliv/garden?style=for-the-badge)](LICENSE)
14+
15+
[![Visit Site](https://img.shields.io/badge/Visit%20Site-gabrioliv.github.io%2Fgarden-brightgreen?style=for-the-badge&logo=github)](https://gabrioliv.github.io/garden/)
16+
   
1217

1318
---
1419

15-
## Instalando o Projeto
20+
## 📋 Pré-requisitos
1621

17-
Clone o repositório:
22+
- [Node.js](https://nodejs.org/) >= 18.0
23+
- npm ou yarn
1824

19-
```bash
20-
git clone git@github.com:GabriOliv/garden.git
21-
```
25+
## 🚀 Instalação e Execução
2226

23-
Entre na pasta do projeto:
27+
### 1. Clone o repositório
2428

2529
```bash
30+
git clone git@github.com:GabriOliv/garden.git
2631
cd garden
2732
```
2833

29-
Instale as dependências:
34+
### 2. Instale as dependências
3035

3136
```bash
3237
npm install
3338
```
3439

35-
Execute o projeto localmente:
40+
### 3. Execute em modo de desenvolvimento
3641

3742
```bash
3843
npm start
3944
```
4045

41-
## Build Local
46+
O site estará disponível em `http://localhost:3000`
47+
48+
## 🔨 Build e Deploy Local
4249

43-
Build do projeto:
50+
### Build para produção
4451

4552
```bash
4653
npm run build
4754
```
4855

49-
Server com build:
56+
### Servir build local
5057

5158
```bash
5259
npm run serve
5360
```
5461

55-
## Deploy Automático
62+
## 🚢 Deploy Automático
5663

57-
O deploy é feito automaticamente pelo GitHub Actions, após a aprovação do Pull Request.
64+
O deploy é realizado automaticamente via GitHub Actions após merge na branch `main`.
5865

59-
- Configuração necessária:
60-
- Adicionar `gh-pages` como branch de deploy.
61-
- Adicionar branch `main` como branch protegida.
66+
### Configuração necessária:
6267

63-
Projeto será publicado na URL: `USERNAME.github.io/garden`
68+
- ✅ Branch `gh-pages` configurada como fonte de deploy no GitHub Pages
69+
- ✅ Branch `main` protegida e com permissão de deploy para a branch de GitHub Pages
6470

65-
---
71+
**URL de publicação:** `USERNAME.github.io/garden`
72+
73+
---

0 commit comments

Comments
 (0)