Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 64 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,67 +103,70 @@ The `infrastructure` module manages the application's external communication, su

Follow the steps below to run the project in development mode.

1. **Copy the configuration file**:
- Copy the `.env.dist` file to `.env` using the command:
```bash
cp .env.dist .env
```

2. **Start the project with Docker using the commands**:
- Creates the necessary Docker network:
```bash
make create-network
```

- Builds Docker images:
```bash
make build
```

- Installs project dependencies:
```bash
make install
```

- Updates project dependencies:
```bash
make upgrade-lib
```

- Seeds the database with initial data:
```bash
make seed
```

- Starts the MongoDB container:
```bash
make mongodb
```

- Starts the LocalStack container:
```bash
make localstack-dev
```

- Creates queues in LocalStack:
```bash
make create-queue-local
```

- Starts the application in development mode:
```bash
make dev
```

- Runs lint and code formatting:
```bash
make lint-format
```

- Automatically generates indices (if needed):
```bash
make generate-index
```
#### 2.1.1. **Copy the configuration file**:

- Copy the `.env.dist` file to `.env` using the command:

```bash
cp .env.dist .env
```

#### 2.1.2. **Start the project with Docker using the commands**:

- Creates the necessary Docker network:
```bash
make create-network
```

- Builds Docker images:
```bash
make build
```

- Installs project dependencies:
```bash
make install
```

- Updates project dependencies:
```bash
make upgrade-lib
```

- Seeds the database with initial data:
```bash
make seed
```

- Starts the MongoDB container:
```bash
make mongodb
```

- Starts the LocalStack container:
```bash
make localstack-dev
```

- Creates queues in LocalStack:
```bash
make create-queue-local
```

- Starts the application in development mode:
```bash
make dev
```

- Runs lint and code formatting:
```bash
make lint-format
```

- Automatically generates indices (if needed):
```bash
make generate-index
```

### 2.2. Documentation

Expand Down
124 changes: 63 additions & 61 deletions README.pt-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,67 +103,69 @@ O módulo `infrastructure` gerencia a comunicação externa da aplicação, como

Siga os passos abaixo para rodar o projeto em modo desenvolvimento.

1. **Copiar o arquivo de configuração**:
- Copie o arquivo `.env.dist` para `.env` com o comando:
```bash
cp .env.dist .env
```

2. **Iniciar o projeto com Docker usando os comandos**:
- Cria a rede Docker necessária para o projeto:
```bash
make create-network
```

- Constrói as imagens Docker:
```bash
make build
```

- Instala as dependências do projeto:
```bash
make install
```

- Atualiza as dependências do projeto:
```bash
make upgrade-lib
```

- Popula o banco de dados com dados iniciais:
```bash
make seed
```

- Inicia container docker do mongodb:
```bash
make mongodb
```

- Inicia container docker do localstack:
```bash
make localstack-dev
```

- Cria filas no localstack:
```bash
make create-queue-local
```

- Inicia a aplicação no modo desenvolvimento:
```bash
make dev
```

- Executa lint e formatação do código:
```bash
make lint-format
```

- Gera índices automaticamente (se necessário):
```bash
make generate-index
```
#### 2.1.1. **Copiar o arquivo de configuração**:

- Copie o arquivo `.env.dist` para `.env` com o comando:
```bash
cp .env.dist .env
```

#### 2.1.2. **Iniciar o projeto com Docker usando os comandos**:

- Cria a rede Docker necessária para o projeto:
```bash
make create-network
```

- Constrói as imagens Docker:
```bash
make build
```

- Instala as dependências do projeto:
```bash
make install
```

- Atualiza as dependências do projeto:
```bash
make upgrade-lib
```

- Popula o banco de dados com dados iniciais:
```bash
make seed
```

- Inicia container docker do mongodb:
```bash
make mongodb
```

- Inicia container docker do localstack:
```bash
make localstack-dev
```

- Cria filas no localstack:
```bash
make create-queue-local
```

- Inicia a aplicação no modo desenvolvimento:
```bash
make dev
```

- Executa lint e formatação do código:
```bash
make lint-format
```

- Gera índices automaticamente (se necessário):
```bash
make generate-index
```


### 2.2. Documentação
Expand Down
Loading