Skip to content

Commit 70a508b

Browse files
committed
docs: atualizando o passo a passo para rodar a API
1 parent 0b71c20 commit 70a508b

File tree

1 file changed

+55
-16
lines changed

1 file changed

+55
-16
lines changed

README.md

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -134,57 +134,96 @@ Na pasta `documentation`, você encontrará o arquivo `architecture.md`. Ao abri
134134
### 1. Clone o repositório:
135135

136136
```bash
137-
git clone https://github.com/seu-usuario/backend-challenge
137+
git clone https://github.com/renanjava/backend-challenge
138138
```
139139

140-
### 2. **Instale as dependências**:
140+
### 2. Acesse o diretório:
141141

142-
No diretório raiz do projeto, execute o seguinte comando para instalar todas as dependências necessárias:
142+
```bash
143+
cd backend-challenge
144+
```
145+
146+
### 3. Abra o projeto com o VSCode:
147+
148+
```bash
149+
code .
150+
```
151+
152+
### 4. *Instale as dependências*:
153+
154+
No terminal da raiz do diretório do projeto, execute o seguinte comando para instalar todas as dependências necessárias:
143155

144156
```bash
145157
npm install
146158
```
147159

148-
### 3. Configure as variáveis de ambiente:
160+
### 5. Configure as variáveis de ambiente:
149161

150-
Renomeie o arquivo `.env.example` para `.env` com o seguinte comando:
162+
Renomeie o arquivo .env.example para .env com o seguinte comando:
151163

152164
```bash
153165
mv .env.example .env
154166
```
155167

156-
### 4. Preencha o arquivo `.env`
168+
### 6. Preencha o arquivo .env
169+
170+
Após renomear o .env.example para .env, preencha o conteúdo do arquivo com os valores abaixo:
157171

158-
Após renomear o `.env.example` para `.env`, preencha o conteúdo do arquivo com os valores abaixo:
159172

160173
```env
161174
PORT=3000
162175
DATABASE_NAME=backend_challenge
163-
DATABASE_URL=postgresql://postgres:password@postgres:5432/${DATABASE_NAME}
176+
DATABASE_URL=postgresql://postgres:password@localhost:5432/${DATABASE_NAME}
164177
JWT_SECRET=cafecomleite
165178
```
166179

167-
## 🖥️ Como Rodar a API
180+
## 🖥 Como Rodar a API
181+
182+
### Primeiramente, execute o Docker Desktop em sua máquina antes de seguir os passos.
168183

169-
#### 1. **Buildar a aplicação pelo Docker-Compose:**
184+
#### 1. _Subir o banco de dados (PostgreSQL) com Docker-Compose:_
170185

171-
No diretório do projeto, execute o seguinte comando para buildar as imagens Docker que irão rodar o banco de dados e a aplicação:
186+
No diretório do projeto, execute o seguinte comando para subir apenas o banco de dados:
172187

173188
```bash
174-
npm run docker:build
189+
npm run docker:up:postgres
190+
```
191+
192+
#### 2. _Aplicar as migrações do banco de dados:_
193+
194+
Com o banco de dados em execução, aplique as migrações:
195+
196+
```bash
197+
npx prisma migrate deploy
198+
```
199+
200+
#### 3. _Gerar o client do Prisma:_
201+
202+
Em seguida, gere o client Prisma:
203+
204+
```bash
205+
npx prisma generate
206+
```
207+
208+
#### 4. _Renomear a DATABASE_URL:_
209+
210+
Em seguida, vá no arquivo .env e altere a URL do banco:
211+
212+
```env
213+
DATABASE_URL=postgresql://postgres:password@postgres:5432/${DATABASE_NAME}
175214
```
176215

177-
#### 2. **Executar a aplicação pelo Docker-Compose:**
216+
#### 5. _Subir a aplicação com Docker-Compose:_
178217

179-
Execute o comando para subir os contêineres:
218+
Agora, inicie o restante dos serviços:
180219

181220
```bash
182221
npm run docker:up
183222
```
184223

185-
#### 3. Realize as requisições na aplicação:
224+
#### 6. _Realizar as requisições na aplicação:_
186225

187-
Após iniciar a aplicação, ela estará disponível em **http://localhost:3000/**:
226+
Após iniciar a aplicação, ela estará disponível em http://localhost:3000/
188227

189228
- [Acesse a coleção do Postman](https://web.postman.co/workspace/53cf501d-84d9-48e7-a29b-4aa5e5e57a16)
190229

0 commit comments

Comments
 (0)