Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eliasrosa committed Nov 24, 2023
1 parent d7412e1 commit dee2ca4
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 3 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,50 @@
## Getting Started
## Requisitos
Para executar este projeto, você precisará ter instalado:
- [Node.js - v18](https://nodejs.org/en/)
- [Docker - v24](https://www.docker.com/)

First, run the development server:
## Primeiros Passos

Para começar, instale as dependências e execute o servidor de desenvolvimento:

```bash
npm install
npm run dev
```
Isso iniciará o servidor de desenvolvimento, permitindo que você trabalhe no projeto.

## Executar o Servidor Mock
Para executar o servidor mock, que estará disponível em http://localhost:1080, utilize o seguinte comando:

```bash
docker compose up
```

## Testes Unitários
Para executar os testes unitários, use os comandos a seguir:

```bash
npm run test
npm run test:watch
```

## Testes End-to-End (e2e)
Execute os testes end-to-end com o comando:

```bash
npm run test:e2e
```

## Build da Aplicação
Para gerar o build da aplicação, utilize o seguinte comando:

```bash
npm run build
```

## Análise de Código (Lint)
Para realizar a análise de código e garantir conformidade com as práticas recomendadas, execute:

```bash
npm run lint
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"build": "tailwindcss ./src/styles/globals.css --output ./src/styles/output.css && next build",
"test:watch": "vitest watch",
"test": "vitest run --coverage",
"test:cy": "cypress open --e2e",
"test:e2e": "cypress open --e2e",
"start": "next start",
"lint": "next lint"
},
Expand Down

0 comments on commit dee2ca4

Please sign in to comment.