... | ... | @@ -10,6 +10,7 @@ Esta seção apresentará todas as configurações para executar o projeto. |
|
|
## Sumário
|
|
|
|
|
|
- [Configurações Gerais](#configurações-gerais)
|
|
|
- [Instalação do ambiente de programação](#instalação-do-ambiente-de-programação)
|
|
|
- [Backend](#backend)
|
|
|
- [Configurando a Máquina](#configurando-a-máquina-do-back)
|
|
|
- [Executando](#rodando-o-projeto-do-back)
|
... | ... | @@ -21,12 +22,13 @@ Esta seção apresentará todas as configurações para executar o projeto. |
|
|
|
|
|
Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.
|
|
|
### Instalação do ambiente de programação
|
|
|
- Instalar o VSCode
|
|
|
- Instalar os plugins do VSCode
|
|
|
- Instalar o VSCode: Tanto no Linux quanto no Windows é possível baixar o instalável do [site oficial da Microsoft](https://code.visualstudio.com/download)
|
|
|
- Instalar os plugins do VSCode: Dentro do VSCode são recomendados (não necessários) alguns plugins que vão facilitar o desenvolvimento, são eles:
|
|
|
- ESLint
|
|
|
- Jest
|
|
|
- Jest Runner
|
|
|
- Github copilot (opcional)
|
|
|
- Instalar Docker: Para instalar o Docker na sua máquina siga as instruções do [Linux](https://docs.docker.com/engine/install/ubuntu/) ou do [Windows](https://docs.docker.com/desktop/windows/install/)
|
|
|
|
|
|
## Backend
|
|
|
|
... | ... | @@ -48,6 +50,8 @@ Para executar o projeto de backend alguns passos simples são necessários: |
|
|
|
|
|
### Rodando o Projeto do Back
|
|
|
|
|
|
#### Localmente
|
|
|
|
|
|
- Após a configuração do ambiente acesse o mesmo diretório do projeto e execute o seguinte comando:
|
|
|
|
|
|
`npm run dev`
|
... | ... | @@ -56,6 +60,18 @@ Para executar o projeto de backend alguns passos simples são necessários: |
|
|
|
|
|
[http://localhost:3031](http://localhost:3031)
|
|
|
|
|
|
#### Docker
|
|
|
|
|
|
- Para executar o backend utilizando o Docker é muito simples, basta rodar os comandos:
|
|
|
|
|
|
`docker-compose build`
|
|
|
|
|
|
`docker-compose -d up`
|
|
|
|
|
|
- Pronto, agora um container do Docker está executando em segundo plano o backend no endereço:
|
|
|
|
|
|
[http://localhost:3031](http://localhost:3031)
|
|
|
|
|
|
## Frontend
|
|
|
|
|
|
### Configurando a Máquina do Front
|
... | ... | @@ -73,11 +89,15 @@ Para a configuração do ambiente de desenvolvimento do front-end: |
|
|
3. Clonar o repositório do front-end com o seguinte comando:
|
|
|
|
|
|
`git clone https://tools.ages.pucrs.br/ucon/front.git`
|
|
|
|
|
|
4. Agora com o terminal aberto no diretório do projeto, execute o seguinte comando:
|
|
|
|
|
|
`yarn install`
|
|
|
|
|
|
### Rodando o Projeto do Front
|
|
|
|
|
|
#### Localmente
|
|
|
|
|
|
- Após os passos de configuração e instalação das dependências, abra o terminal no diretório do projeto e utilize o seguinte comando para iniciar o front:
|
|
|
|
|
|
`yarn start`
|
... | ... | @@ -86,3 +106,15 @@ Para a configuração do ambiente de desenvolvimento do front-end: |
|
|
|
|
|
[http://localhost:3000](http://localhost:3000)
|
|
|
|
|
|
#### Docker
|
|
|
|
|
|
- Para executar o backend utilizando o Docker é muito simples, basta rodar os comandos:
|
|
|
|
|
|
`docker-compose build`
|
|
|
|
|
|
`docker-compose -d up`
|
|
|
|
|
|
- Pronto, agora um container do Docker está executando em segundo plano o backend no endereço:
|
|
|
|
|
|
[http://localhost:3031](http://localhost:3031)
|
|
|
|