Skip to content

Commit

Permalink
adiciona manual da instalação front e service
Browse files Browse the repository at this point in the history
  • Loading branch information
ciceroff committed Sep 13, 2024
1 parent 347e70c commit 9e94aa5
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/manual-de-instalacao/front.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Front

Configure as variáveis de ambiente transferindo o conteúdo do arquivo `.env.example` para o arquivo `.env`:

```bash
SERVICE_URL=http://localhost:8080
NEXT_PUBLIC_API_URL=http://localhost:8080
LOGIN_REDIRECT_URL=http://127.0.0.1:3000
GITHUB_CLIENT_ID=
GITHUB_SECRET=

```

É importante salientar que a integração da autenticação do github, assim como a importação de repositórios, só pode ser feita em produção.

Utilize o docker para rodar:

```bash
docker-compose up
```

Ou rode manualmente:

```bash
yarn

yarn dev
```
34 changes: 34 additions & 0 deletions docs/manual-de-instalacao/service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Service

Configura as variáveis de ambiente do repositório. Existe um env-vars-example no projeto, é possível pegar o conteúdo dessa pasta e mover para uma pasta env-vars. Ou você pode criar manualmente a pasta `env-vars` e criar os seguintes arquivos dentro dela: `.service.env` e `.postgres.env`

Na `.postgres.env`:

```bash
POSTGRES_HOST=db
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PORT=5432
POSTGRES_PASSWORD=postgres
```

Na `.service.env`:

```bash
DEBUG=TRUE
CREATE_FAKE_DATA=TRUE

LOGIN_REDIRECT_URL=http://127.0.0.1:3000/
GITHUB_CLIENT_ID=CLIENT_ID
GITHUB_SECRET=GITHUB_SECRET
SECRET_KEY=django-insecure-9(nkl$g75ia=@q3p*s83rc9y=q5=!q@kr8+s3*xc-t441#jmg%
AMBIENT_TEST_OR_DEV=TRUE
```
É importante salientar que a integração da autenticação do github, assim como a importação de repositórios, só pode ser feita em produção.
Utilize o docker para rodar:
```bash
docker-compose up
```
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ repo_name: "2024.1-MeasureSoftGram-DOC"
repo_url: "https://github.com/fga-eps-mds/2024.1-MeasureSoftGram-DOC"

theme:
name: material
name: mkdocs
language: "pt"
logo: "assets/logo.svg"
favicon: "assets/logo.svg"
Expand Down Expand Up @@ -36,3 +36,6 @@ nav:
- Código de conduta: guia-de-contribuicao/codigo-de-conduta.md
- Politica de commits: guia-de-contribuicao/politica-de-commits.md
- Politica de branches: guia-de-contribuicao/politica-de-branch.md
- Manual de instalação:
- Service: manual-de-instalacao/service.md
- Front: manual-de-instalacao/front.md

0 comments on commit 9e94aa5

Please sign in to comment.