|
1 | | -# Garden |
| 1 | +# 🌱 Garden |
2 | 2 |
|
3 | 3 | > Uma Coleção de Notas em Evolução. |
4 | 4 |
|
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. |
6 | 6 |
|
7 | | -[](https://docusaurus.io/) |
8 | | - |
| 7 | +[](https://docusaurus.io/) |
| 8 | + |
9 | 9 | [](https://github.com/GabriOliv/garden/actions) |
10 | | - |
| 10 | + |
11 | 11 | [](https://gabrioliv.github.io/garden/) |
| 12 | + |
| 13 | +[](LICENSE) |
| 14 | + |
| 15 | +[](https://gabrioliv.github.io/garden/) |
| 16 | + |
12 | 17 |
|
13 | 18 | --- |
14 | 19 |
|
15 | | -## Instalando o Projeto |
| 20 | +## 📋 Pré-requisitos |
16 | 21 |
|
17 | | -Clone o repositório: |
| 22 | +- [Node.js](https://nodejs.org/) >= 18.0 |
| 23 | +- npm ou yarn |
18 | 24 |
|
19 | | -```bash |
20 | | -git clone git@github.com:GabriOliv/garden.git |
21 | | -``` |
| 25 | +## 🚀 Instalação e Execução |
22 | 26 |
|
23 | | -Entre na pasta do projeto: |
| 27 | +### 1. Clone o repositório |
24 | 28 |
|
25 | 29 | ```bash |
| 30 | +git clone git@github.com:GabriOliv/garden.git |
26 | 31 | cd garden |
27 | 32 | ``` |
28 | 33 |
|
29 | | -Instale as dependências: |
| 34 | +### 2. Instale as dependências |
30 | 35 |
|
31 | 36 | ```bash |
32 | 37 | npm install |
33 | 38 | ``` |
34 | 39 |
|
35 | | -Execute o projeto localmente: |
| 40 | +### 3. Execute em modo de desenvolvimento |
36 | 41 |
|
37 | 42 | ```bash |
38 | 43 | npm start |
39 | 44 | ``` |
40 | 45 |
|
41 | | -## Build Local |
| 46 | +O site estará disponível em `http://localhost:3000` |
| 47 | + |
| 48 | +## 🔨 Build e Deploy Local |
42 | 49 |
|
43 | | -Build do projeto: |
| 50 | +### Build para produção |
44 | 51 |
|
45 | 52 | ```bash |
46 | 53 | npm run build |
47 | 54 | ``` |
48 | 55 |
|
49 | | -Server com build: |
| 56 | +### Servir build local |
50 | 57 |
|
51 | 58 | ```bash |
52 | 59 | npm run serve |
53 | 60 | ``` |
54 | 61 |
|
55 | | -## Deploy Automático |
| 62 | +## 🚢 Deploy Automático |
56 | 63 |
|
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`. |
58 | 65 |
|
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: |
62 | 67 |
|
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 |
64 | 70 |
|
65 | | ---- |
| 71 | +**URL de publicação:** `USERNAME.github.io/garden` |
| 72 | + |
| 73 | +--- |
0 commit comments