RotulAI 🗂

Descrição ℹ️

Plataforma mobile de descrição de arquivos criado para o HackathAN - Desafio do Arquivo Nacional 2024

Time 🏆

• Gabriella Graciano - Designer
• Gustavo Lima - Desenvolvedor/GustavoHLMA
• Leonardo Seabra - Designer
• Luis Lauriano - Desenvolvedor/luislauriano
• Sérgio Luís - Desenvolvedor/sergioluisfilho

Documentação 📄

• Figma

Tecnologias ⚙️

• Typescript
• Express.js
• PostgreSQL
• React Native

Instalação ⬇️

- git clone https://github.com/sergioluisfilho/RotulAI.git
- npm install

Rodando o projeto - Client 🏃

Na pasta rotulAI-app

- npx expo start

Rodando o projeto - Server 🏃

Na pasta backend

- npm start

Como contribuir 🤝

Branches

Pull requests devem ser compostos pelo tipo e nome da branch.
os nomes das branchs devem ser separados por "-".
os tipo são compostos por:

• feature - Para novas funcionalidades
• fix - Para bugfixes e hotfixes

Exemplo: feature/navbar-mobile

Commits

Commits devem ser estruturados da seguinte forma (): <descrição do commit>
Exemplo: feature(navbar-mobile): adicionando navegação

Branch padrão

• develop

Pull requests

Pull requests devem ter uma boa e clara descrição.
Os 2 principais tópicos da descrição devem ser: - What I did - How to test