Skip to content

Commit

Permalink
docs(readme): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
4lessandrodev committed May 7, 2022
1 parent be6520f commit 500dabd
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,52 @@ Neste projeto financeiro para controle de finanças foi aplicado domain-driven-d
### Documentação da Api
Disponível [no link](https://finance-api-ddd.herokuapp.com/doc)

### Como rodar esse projeto

Para rodar o projeto local em sua máquina utilizando docker

- Realize o clone deste projeto para sua máquina.

```sh

$ git clone https://github.com/4lessandrodev/finance-project-ddd.git

```

- Crie seu arquivo .env utilizando como exemplo o arquivo .env.example

- Execute o docker

```sh

$ docker-compose up -d

```

- Instale as dependências

```sh

$ yarn

```

- Execute o projeto

```sh

$ yarn start:dev

```

- Acesse a api em `http://localhost:3000/graphql


### Rodar os testes

- yarn test


### Cobertura de tests

<img src="./readme/test-cov.png" alt="imagem" width="100%">
Expand Down

0 comments on commit 500dabd

Please sign in to comment.