diff --git a/.gitignore b/.gitignore index c9a988c..5850423 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,8 @@ .env node_modules /dist -.vscode \ No newline at end of file +.vscode + +package-lock.json + +*log \ No newline at end of file diff --git a/DEPLOY_CHECKLIST.md b/DEPLOY_CHECKLIST.md new file mode 100644 index 0000000..272258f --- /dev/null +++ b/DEPLOY_CHECKLIST.md @@ -0,0 +1,59 @@ +# ✅ Checklist de Deploy - Time for Code Frontend + +## 🔒 Segurança + +- [x] **Arquivo .env no .gitignore** - Variáveis sensíveis não serão commitadas +- [x] **Zero URLs hardcoded** - Todas as URLs da API usam variáveis de ambiente +- [x] **Configuração limpa** - Apenas exemplos genéricos nos arquivos de documentação + +## 🚀 Configuração Vercel + +- [x] **vercel.json** - Configurado para SPA (Single Page Application) +- [x] **package.json** - Scripts de build configurados corretamente +- [x] **Build testado** - `npm run build` funciona sem erros + +## 🔧 Variáveis de Ambiente + +### Para Deploy na Vercel: +1. Acesse o dashboard da Vercel +2. Vá em **Settings > Environment Variables** +3. Adicione: + - **Name**: `VITE_API_BASE_URL` + - **Value**: `https://sua-api-producao.com` + - **Environment**: Production (e Preview se desejar) + +## 📁 Arquivos Importantes + +- [x] `src/config/api.js` - Configuração centralizada da API +- [x] `vite.config.js` - Proxy configurado para desenvolvimento +- [x] `vercel.json` - Configuração para SPA +- [x] `package.json` - Scripts de build +- [x] `.gitignore` - Protege arquivos sensíveis +- [x] `README.md` - Documentação atualizada +- [x] `env.example` - Exemplo de configuração + +## 🎯 Próximos Passos + +1. **Commit das alterações:** + ```bash + git add . + git commit -m "feat: configure environment variables and deploy setup" + ``` + +2. **Push para GitHub:** + ```bash + git push origin main + ``` + +3. **Configurar Vercel:** + - Conectar repositório GitHub + - Configurar variável de ambiente + - Deploy automático ativado + +## ✅ Status: PRONTO PARA DEPLOY + +O projeto está configurado corretamente para: +- ✅ Deploy automático na Vercel +- ✅ Uso seguro de variáveis de ambiente +- ✅ Funcionamento em desenvolvimento e produção +- ✅ Zero informações sensíveis no repositório \ No newline at end of file diff --git a/README.md b/README.md index 071fb1b..f61fa95 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,63 @@ O Time for Code está sendo desenvolvido para crianças e adolescentes que estã - **Lucas [(zlucasftw)](https://github.com/zlucasftw)**: Desenvolvedor Backend - **Layla [(laycsz)](https://github.com/laycsz)**: Desenvolvedora Frontend e Designer UI/UX - **Arthur [(ArthurVenturi)](https://github.com/ArthurVenturi)**: Desenvolvedor Frontend + +# Time for Code - Frontend + +## Configuração de Variáveis de Ambiente + +### Desenvolvimento Local + +1. Copie o arquivo `env.example` para `.env`: +```bash +cp env.example .env +``` + +2. Configure a URL da API no arquivo `.env`: + +**Para testar API de produção:** +```bash +VITE_API_BASE_URL=https://sua-api-producao.com +``` + +**Para API local:** +```bash +VITE_API_BASE_URL=http://localhost:3000 +``` + +**Nota:** Em desenvolvimento, o sistema usa proxy do Vite automaticamente para APIs externas. + +### Deploy na Vercel + +1. Acesse o dashboard da Vercel +2. Vá para **Settings > Environment Variables** +3. Adicione a variável: + - **Name**: `VITE_API_BASE_URL` + - **Value**: `https://sua-api-producao.com` + - **Environment**: Production (e Preview se desejar) + +### Vantagens da Configuração + +✅ **Flexível**: Pode usar qualquer URL da API através de variáveis de ambiente +✅ **Seguro**: URLs não ficam hardcoded no código +✅ **Portável**: Funciona em qualquer ambiente (dev, staging, prod) +✅ **Manutenível**: Fácil de mudar URLs sem alterar código + +### Estrutura de Arquivos + +- `src/config/api.js` - Configuração centralizada da API +- `src/api/` - Endpoints da API +- `src/contexts/` - Contextos do React + +## Scripts Disponíveis + +- `npm run dev` - Inicia o servidor de desenvolvimento +- `npm run build` - Gera build de produção +- `npm run vercel-build` - Build específico para Vercel + +## Tecnologias + +- React 19 +- Vite +- TanStack Router +- TanStack Query diff --git a/SETUP_PRODUCTION_TEST.md b/SETUP_PRODUCTION_TEST.md new file mode 100644 index 0000000..93e8f2a --- /dev/null +++ b/SETUP_PRODUCTION_TEST.md @@ -0,0 +1,55 @@ +# Configuração para Testar API de Produção + +## Passo 1: Configurar o arquivo .env + +Edite o arquivo `.env` e configure a URL da API: + +```bash +# Para testar API de produção +VITE_API_BASE_URL=https://sua-api-producao.com + +# Para API local (alternativa) +# VITE_API_BASE_URL=http://localhost:3000 +``` + +## Passo 2: Testar localmente + +Execute o projeto: + +```bash +npm run dev +``` + +O sistema vai automaticamente: +- Usar a URL configurada em `VITE_API_BASE_URL` +- Se for uma URL externa, usar o proxy do Vite para evitar CORS +- Redirecionar `/api/*` para a URL configurada + +## Passo 3: Testar funcionalidades + +1. Acesse: http://localhost:5175 +2. Teste o cadastro de usuário +3. Teste o login +4. Verifique se não há erros de CORS + +## Passo 4: Preparar para Deploy + +Quando estiver funcionando, você pode: + +1. Fazer commit das alterações +2. Fazer push para o GitHub +3. Na Vercel, configurar a variável de ambiente: + - **Name**: `VITE_API_BASE_URL` + - **Value**: `https://sua-api-producao.com` + +## Como funciona: + +- **Desenvolvimento**: Usa proxy do Vite (`/api/*` → `VITE_API_BASE_URL/*`) +- **Produção**: Usa URL direta (`VITE_API_BASE_URL/*`) + +## Vantagens desta configuração: + +✅ **Flexível**: Pode usar qualquer URL da API +✅ **Seguro**: URLs não ficam hardcoded no código +✅ **Portável**: Funciona em qualquer ambiente +✅ **Manutenível**: Fácil de mudar URLs sem alterar código \ No newline at end of file diff --git a/env.example b/env.example new file mode 100644 index 0000000..98daf42 --- /dev/null +++ b/env.example @@ -0,0 +1,16 @@ +# Exemplo de variáveis de ambiente +# Copie este arquivo para .env e configure os valores + +# URL base da API +# Para desenvolvimento local com API local: +VITE_API_BASE_URL=http://localhost:3000 + +# Para desenvolvimento local com API remota: +# VITE_API_BASE_URL=https://sua-api-producao.com + +# Para produção, use a URL da sua API: +# VITE_API_BASE_URL=https://sua-api-producao.com + +# NOTA: O sistema usa variáveis de ambiente para máxima flexibilidade +# Em desenvolvimento, usa proxy do Vite para APIs externas +# Em produção, usa a URL direta configurada na Vercel diff --git a/index.html b/index.html index 1342602..8f2ab37 100644 --- a/index.html +++ b/index.html @@ -10,21 +10,19 @@ - - - - + +