Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • C cineclube-wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Cine Clube
  • cineclube-wiki
  • Wiki
  • configuracao

configuracao · Changes

Page history
Add environment setup tutorial authored Mar 26, 2021 by Patrick Flores's avatar Patrick Flores
Hide whitespace changes
Inline Side-by-side
configuracao.md
View page @ 72803877
|[Home](home)|[Sprints](sprints)|[Requisitos](requisitos)|[Arquitetura](arquitetura)|[Configuração](configuracao)|[Mockups](mockups)|[BD](banco_dados)|[Instalação](instalacao)|[GP](gp)|[Horários](horarios)|[Processo](processo)
|---|---|---|---|---|---|---|---|---|---|---|
| [Home](home) | [Sprints](sprints) | [Requisitos](requisitos) | [Arquitetura](arquitetura) | [Configuração](configuracao) | [Mockups](mockups) | [BD](banco_dados) | [Instalação](instalacao) | [GP](gp) | [Horários](horarios) | [Processo](processo) |
| ------------ | ------------------ | ------------------------ | -------------------------- | ---------------------------- | ------------------ | ----------------- | ------------------------ | -------- | -------------------- | -------------------- |
# Configuração do Projeto
## Links
**Tópicos**
- [Links](#links)
- [Instalação do Node](#instalação-do-node)
- [Instalação do Docker](#instalação-do-docker)
- [Instalação do MySql](#instalação-di-mysql)
- [Configuração do Ambiente de Desenvolvimento](#configuração-do-ambiente-de-desenvolvimento)
- [Execução dos Projetos](#execução-dos-projetos)
- [Backend](#backend)
- [Frontend](#frontend)
## **Links**
- **Back-end repo:** https://tools.ages.pucrs.br/cine-clube/backend
......@@ -11,7 +22,114 @@
- **Homologação:** http://hml.ages.pucrs.br
Aqui deve ser explicado como configurar o Ambiente para que os Desenvolvedores do Projeto possam configurar o projeto para rodar em seus computadores, deve ser sempre atualizado a cada mudança de instalação feita.
## **Instalação do Node**
**Instalação**
O download do instalador do Node pode ser realizado pelo seguinte [link](https://nodejs.org/en/).
Faça o download e siga os passos de instalação da versão mais recente que possua LTS (Long Term Support).
Para verificar se o node foi instalado corretamente, execute o comando `node -v` e verifique se o retorno é semelhante ao apresentado abaixo (caso a versão seja diferente não se preocupe).
```
node -v
v14.16.0
```
## **Instalação do Docker**
Tutorial de instalação: [Windows](https://docs.docker.com/docker-for-windows/install/#install-docker-desktop-on-windows) / [Ubuntu](https://docs.docker.com/engine/install/ubuntu/) / [Debian](https://docs.docker.com/engine/install/debian/)
## **Instalação do MySql**
Para realizar a instalação de uma instância do MySql através do docker, utilize o comando abaixo.
**Caso esteja no Windows, utilize o PowerShell.**
**Caso esteja usando Linux, deve-se adicionar `sudo` antes de cada comando do docker.**
```
docker run --name <nome-do-container> -e MYSQL_ROOT_PASSWORD=<senha-root> -e MYSQL_USER=<nome-usuario> -e MYSQL_PASSWORD=<senha-usuario> -e MYSQL_DATABASE=cine_clube -p 3306:3306 -d mysql:latest
```
Onde:
- `<nome-do-container>` é o nome do container a ser criado. Ex: cine-clube-mysql.
- `<senha-root>` é a senha que será utilizada para acessar o banco de dados como usuário root.
- `<nome-usuario>` é o nome de usuário que será utilizado para acesso ao banco de dados e `<senha-usuario>` é a senha do mesmo.
O comando final será algo como o exemplo abaixo.
```
docker run --name cine-clube-mysql -e MYSQL_ROOT_PASSWORD=rootpass123 -e MYSQL_USER=myuser -e MYSQL_PASSWORD=mypassword -e MYSQL_DATABASE=cine_clube -p 3306:3306 -d mysql:latest
```
## **Configuração do Ambiente de Desenvolvimento**
### Aplicações necessárias
- Visual Studio Code: [link para download do VisualStudio Code](https://code.visualstudio.com/download)
- Postman: [link para download do Postman](https://www.postman.com/downloads/)
**OBS: Não é necessário criar uma conta para utilizar o Postman. Ao iniciar o app, simplesmente clique em `"Skip signing in and take me straigt to the app"`**
**VisualStudio Code**
Utilizaremos o VisualStudio Code para o desenvolvimento da aplicação. Para facilitar no desenvolvimento, instale os seguintes pacotes:
- ESLint
- Prettier
- Docker
Após a instalação das extensões, vá nas configurações do VisualStudio Code (File > Preferences > Settings), procure `format on save` e marque a opção **Editor: Format On Save**.
**Postman**
O Postman é utilizado para testar as rotas/endpoints do backend.
TODO: Adicionar exemplo/descrição.
## **Execução dos Projetos**
### Backend
#### Pré-requesitos
- Node.js
- npm
#### Iniciando
- Clonar este repositório
`git clone http://tools.ages.pucrs.br/cine-clube/backend.git`
- Entrar no diretório do projeto
`cd backend`
- Instalar as dependências
`npm install`
- Iniciar a aplicação
`npm run dev`
- Acesse pelo navegador
`http://localhost:5000`
### Frontend
#### Pré-requesitos
- Node.js
- Yarn ou npm
#### Iniciando
* Deve ser explicado a configuração de **TODAS** as partes do projeto, tanto BACK,BANCO,FRONT,etc...
* Além de explicar aqui, deve ter em cada Repositório o **RESUMO** de como instalar para quando os Desenvolvedores baixarem o projeto possam configurar por lá também
\ No newline at end of file
- Clonar este repositório
`git clone http://tools.ages.pucrs.br/cine-clube/frontend.git`
- Entrar no diretório do projeto
`cd frontend`
- Instalar as dependências
`npm install` ou `yarn install`
- Iniciar a aplicação
`npm start` ou `yarn start`
- Acesse pelo navegador
`http://localhost:3000`
Clone repository
  • Imagens
    • cineclube cronograma.pdf
  • Utilizando a wiki
    • adicionando imagens
    • escrevendo em markdown
    • wiki no editor de texto
  • arquitetura
  • banco_dados
  • configuracao
  • gp
  • Home
  • horarios
  • instalacao
  • mockups
  • processo
  • requisitos
  • sprints