Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • Wiki Wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • 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
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Create a new issue
  • Jobs
  • Issue Boards
Collapse sidebar
  • Saúde Bucal Quilombola
  • WikiWiki
  • Wiki
  • configuracao

configuracao · Changes

Page history
Update configuracao authored Apr 04, 2025 by Arthur Mariano Foltz Barroso's avatar Arthur Mariano Foltz Barroso
Show whitespace changes
Inline Side-by-side
configuracao.md
View page @ 3eb0ae84
```markdown
# Saúde Bucal para Quilombos - Frontend
Este é o repositório frontend do projeto Saúde Bucal para Quilombos, desenvolvido com React, TypeScript, Vite e Tailwind CSS.
## 📋 Pré-requisitos
Antes de começar, certifique-se de ter instalado:
- [Node.js](https://nodejs.org/) (versão 18 ou superior)
- npm (geralmente vem com o Node.js)
- Git
## 🚀 Configuração Inicial
Siga os passos abaixo para configurar e iniciar o projeto localmente:
### 1. Clone o repositório
```bash
git clone https://tools.ages.pucrs.br/saude-bucal-quilombola/front-end.git
cd front-end
```
### 2. Instale as dependências
```bash
npm install
```
### 3. Configure as variáveis de ambiente
Crie um arquivo `.env` na raiz do projeto baseado no arquivo `.env.example`:
```bash
cp .env.example .env
```
Abra o arquivo `.env` e configure as variáveis necessárias:
```
VITE_API_URL=http://localhost:3001
```
> **Nota**: Ajuste a URL da API conforme necessário para seu ambiente de desenvolvimento.
### 4. Inicie o servidor de desenvolvimento
```bash
npm run dev
```
Isso iniciará o servidor de desenvolvimento Vite. Abra seu navegador e acesse `http://localhost:5173` para ver a aplicação em execução.
## 📁 Estrutura de Pastas
```
src/
├── assets/ # Arquivos estáticos (imagens, fontes)
├── components/ # Componentes reutilizáveis
│ ├── common/ # Componentes gerais (botões, inputs)
│ ├── layout/ # Componentes de layout (Header, Footer)
│ └── features/ # Componentes específicos de funcionalidades
├── hooks/ # Hooks personalizados
├── pages/ # Páginas da aplicação
├── routes/ # Configuração de rotas
├── services/ # Serviços e integrações
│ └── api/ # Configurações e chamadas de API
├── store/ # Gerenciamento de estado (se aplicável)
├── styles/ # Estilos globais e temas
├── types/ # Tipos e interfaces TypeScript
├── utils/ # Funções utilitárias
├── App.tsx # Componente principal
└── main.tsx # Ponto de entrada da aplicação
```
## 🛠️ Scripts Disponíveis
- `npm run dev` - Inicia o servidor de desenvolvimento
- `npm run build` - Compila o projeto para produção
- `npm run lint` - Executa o linter para verificar o código
- `npm run preview` - Pré-visualiza a build de produção localmente
- `npm run tailwind:init` - Inicializa o Tailwind CSS (já executado)
```
\ No newline at end of file
## 🚀 Como rodar o projeto
### 📦 Backend
1. **Pré-requisitos**:
- Node.js
- Docker
2. **Clonar repositório e acessar pasta**:
```bash
git clone <url-do-repositorio-backend>
cd backend
```
3. **Executar o script de inicialização**:
```bash
chmod +x start-backend.sh
./start-backend.sh
```
4. A API estará disponível em `http://localhost:3001`
A documentação Swagger pode ser acessada em `http://localhost:3001/api`
---
### 🎨 Frontend
1. **Pré-requisitos**:
- Node.js 18+
- npm
- Git
2. **Clonar repositório e acessar pasta**:
```bash
git clone <url-do-repositorio-frontend>
cd front-end
```
3. **Instalar dependências**:
```bash
npm install
```
4. **Configurar variáveis de ambiente**:
```bash
cp .env.example .env
```
Edite o `.env` e ajuste a `VITE_API_URL`, exemplo:
```
VITE_API_URL=http://localhost:3001
```
5. **Iniciar o servidor**:
```bash
npm run dev
```
6. A aplicação estará disponível em `http://localhost:5173`
---
Clone repository

Navegação

  • Home
  • Escopo e Cronograma
  • Processo
  • Design/Mockups
  • Configuração
  • Arquitetura
  • Infra
  • Código
  • BD