README.md 2.91 KB
Newer Older
Nicholas Spolti's avatar
Nicholas Spolti committed
1
2
# Gastrô Frontend

3
Bem-vindo ao **Gastrô Frontend**! Este projeto é um Frontend desenvolvido com **Node.js, React-Native, Tailwind, TypeScript, Expo, Material UI**.
Nicholas Spolti's avatar
Nicholas Spolti committed
4

5
6
## 📌 **Pré-requisitos**
Antes de rodar o projeto, certifique-se de ter instalado:
7
- [Node.js](https://nodejs.org/dist/v20.19.0/node-v20.19.0-x64.msi) (versão 20.19 LTS)
8
9
- [Git](https://git-scm.com/)
- Expo - App mobile
Nicholas Spolti's avatar
Nicholas Spolti committed
10
11


12
13
14
15
16
## 🚀 **Rodando o Projeto**
### **1️⃣ Clonar o repositório**
```sh
  git clone https://tools.ages.pucrs.br/gastro/gastro-frontend.git
  cd gastro-frontend
17
  cd gastro
Nicholas Spolti's avatar
Nicholas Spolti committed
18
```
19
20
## **Criando Branch**
```sh
21
22
23
  git checkout development
  git pull
  git checkout -b feature/US-NUMERO-nome-feat (exemplo: feature/US-03-tela-login) (exemplo com fix: fix/US-03-tela-login)
24
25
26
```
## **Fazendo commit**
```sh
27
28
29
30
  git status
  git add .
  git commit -m 'feat:o que eu fiz' (exemplo: 'feat: adiciona componente input') (exemplo com fix: 'fix: ajusta componente input')
  git push
Nicholas Spolti's avatar
Nicholas Spolti committed
31
32
```

33
## **Merge Request**
Nicholas Spolti's avatar
Nicholas Spolti committed
34

35
36
- Acessar o [site do tools](https://tools.ages.pucrs.br/gastro/gastro-frontend/-/branches);
- Selecionar a sua branch;
37
- Solicitar o merge request;
38
39
    
Obs: lembre-se de adicionar capturas de tela e explicações do que foi feito.
Nicholas Spolti's avatar
Nicholas Spolti committed
40

41
---
Nicholas Spolti's avatar
Nicholas Spolti committed
42

43
### 🏗️ Construção e execução
Nicholas Spolti's avatar
Nicholas Spolti committed
44

45
Caso queira rodar pelo computador:
Nicholas Spolti's avatar
Nicholas Spolti committed
46

47
48
49
50
```sh
npm install          # Instala dependências
npx expo start       # Inicia o expo
```
Nicholas Spolti's avatar
Nicholas Spolti committed
51
52


53
---
Nicholas Spolti's avatar
Nicholas Spolti committed
54

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
## 📄 **Estrutura do Projeto**
```
📦 gastro-frontend
├── 📂 .expo # Arquivos de configuração do Expo
├── 📂 app # Arquivos principais de layout e navegação
│ ├── 📄 _layout.tsx # Layout principal do app
│ └── 📄 index.tsx # Tela inicial do app
├── 📂 assets # Imagens, fontes e recursos estáticos
├── 📂 components # Componentes reutilizáveis da aplicação
├── 📂 constants # Constantes usadas no projeto
├── 📂 hooks # Hooks personalizados React
├── 📂 node_modules # Dependências instaladas (gerado automaticamente)
├── 📂 screens # Telas e páginas do app
├── 📂 utils # Funções utilitárias
├── 📄 .gitignore # Arquivos ignorados pelo Git
├── 📄 app.json # Configuração do Expo/App
├── 📄 expo-env.d.ts # Tipagens adicionais do Expo
├── 📄 package-lock.json # Versões exatas das dependências instaladas
├── 📄 package.json # Dependências e scripts npm
├── 📄 README.md # Documentação principal
└── 📄 tsconfig.json # Configuração do TypeScript
```
Nicholas Spolti's avatar
Nicholas Spolti committed
77

78
---
Nicholas Spolti's avatar
Nicholas Spolti committed
79
80


81
## 🛠 Tecnologias Utilizadas
Nicholas Spolti's avatar
Nicholas Spolti committed
82

83
84
85
86
87
88
- **Node.js**: [Documentação](https://nodejs.org/)
- **TypeScript**: [Documentação](https://www.typescriptlang.org/)
- **Expo**: [Documentação](https://expo.dev/)
- **Tailwind**: [Documentação](https://tailwindcss.com/)
- **React-Native**: [Documentação](https://reactnative.dev/)
- **Material UI**: [Documentação](https://mui.com/material-ui/?srsltid=AfmBOoqZlbpch5ix4GRFQgbEHYn2iyE6ir3-5An62BooFfeSSg7S7bGh)