From 9e94aa5640d997bce87bee9eaffaf84b03cfa075 Mon Sep 17 00:00:00 2001 From: ciceroff Date: Fri, 13 Sep 2024 16:55:32 -0300 Subject: [PATCH] =?UTF-8?q?adiciona=20manual=20da=20instala=C3=A7=C3=A3o?= =?UTF-8?q?=20front=20e=20service?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/manual-de-instalacao/front.md | 28 +++++++++++++++++++++++ docs/manual-de-instalacao/service.md | 34 ++++++++++++++++++++++++++++ mkdocs.yml | 5 +++- 3 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 docs/manual-de-instalacao/front.md create mode 100644 docs/manual-de-instalacao/service.md diff --git a/docs/manual-de-instalacao/front.md b/docs/manual-de-instalacao/front.md new file mode 100644 index 0000000..33c4e18 --- /dev/null +++ b/docs/manual-de-instalacao/front.md @@ -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 +``` diff --git a/docs/manual-de-instalacao/service.md b/docs/manual-de-instalacao/service.md new file mode 100644 index 0000000..02621a0 --- /dev/null +++ b/docs/manual-de-instalacao/service.md @@ -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 +``` diff --git a/mkdocs.yml b/mkdocs.yml index 4083f17..ff7873a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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" @@ -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