Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README with step-by-step guide #61

Merged
merged 1 commit into from
Oct 13, 2024
Merged
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
73 changes: 4 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,7 @@ Este projeto é uma aplicação open source feita em Go no backend e React no fr
cd faladev
```

2. **Instale o Go:**

Certifique-se de ter o Go instalado na versão 1.21 ou superior. Você pode verificar sua versão do Go com o comando:

```bash
go version
```

Para instalar ou atualizar o Go, siga as instruções oficiais: [Instalação do Go](https://golang.org/doc/install)

3. **Configurar Credenciais do Google Console:**
2. **Configurar Credenciais do Google Console:**

Para que a aplicação possa acessar o Google Calendar e enviar emails, você precisa configurar as credenciais no Google Console:

Expand Down Expand Up @@ -55,50 +45,21 @@ Este projeto é uma aplicação open source feita em Go no backend e React no fr
Crie Credenciais OAuth 2.0:

- Vá para "API & Services" > "Credentials".
- Clique em "Create Credentials" e selecione "OAuth 2.0 Client IDs".
- Escolha "Web application".
- Adicione os URIs de redirecionamento autorizados. Exemplo: http://localhost:8080/callback
- Clique em "Create Credentials" e selecione "ID do cliente OAuth".
- Quando solicitado, adicione os URIs de redirecionamento autorizados. Exemplo: http://localhost:8080/callback
- Salve as credenciais e anote o Client ID e Client Secret.

4. **Configurar Variáveis de Ambiente:**

Crie um arquivo .env no diretório ./backend e adicione as seguintes variáveis, incluindo suas credenciais do Google:

```env
GOOGLE_MEET_EVENT=https://meet.google.com/link-do-meet-do-evento
GOOGLE_REDIRECT_URL=http://localhost:8080/callback
GOOGLE_CLIENT_ID=seu-client-id
GOOGLE_CLIENT_SECRET=seu-client-secret
DATABASE_URL=sua-string-de-conexao-postgresql
```

5. **Instalar Dependências:**

Execute o comando abaixo para instalar as dependências do projeto:

```bash
make deps
```

6. **Rodar o Projeto:**

Para iniciar a aplicação, execute o comando:

```bash
go run cmd/api/main.go
```
Na primeira vez que você rodar o projeto, você deverá acessar o link será gerado no console para autorizar o seu aplicativo na sua conta Google.


7. **Para inspecionar o código:**

Para verificar a conformidade do código com as diretrizes de estilo, utilize o seguinte comando:

```bash
make lint
```

## Instruções para com Docker
## Instruções para executar a aplicação utilizando Docker Compose

Para iniciar a aplicação, execute o comando:

Expand All @@ -118,32 +79,6 @@ Este projeto é uma aplicação open source feita em Go no backend e React no fr
docker system prune -a --volumes
```

## Como usar o Debugger do VScode com Docker?

Tendo iniciado a aplicação com o comando do `docker compose` basta navegar até a aba `Run and Debug` do VSCode.

O comando padrão para acessar essa aba é `Ctrl+Shift+D` ou no Mac `Cmd+Shift+D`. Caso não seja o seu comando padrão você pode se basear [nessa](https://code.visualstudio.com/Docs/editor/debugging) documentação oficial.

Selecione a opção `Connect to server` e clique no botão de Play.
![Run and debug tutorial](.github/images/run_and_debug.png)


## Como atualizar a documentação Swagger?

Instale o pacote golang `swag`:

```bash
go install github.com/swaggo/swag/cmd/swag@latest
```

Vá para a pasta backend e rode o seguinte comando:

```bash
path/to/the/go/bin/swag init -g ./cmd/api/main.go -o cmd/docs
```

![Run and debug tutorial](.github/images/run_and_debug.png)

## Como Usar

Para acessar a aplicação:
Expand Down
Loading