Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (79 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

128 lines (79 loc) · 1.9 KB

Como Contribuir - Seu Passaporte de Entrada

Estamos felizes em receber você aqui e saber que está interessado em contribuir para o nosso projeto. Como um projeto de código aberto, cada contribuição é valorizada e ajuda a impulsionar o crescimento e a qualidade do nosso trabalho.

Este guia foi criado para orientá-lo sobre como você pode participar tanto do backend quanto do mobile, que fazem parte deste repositório principal.

Código de Conduta

Para garantir um ambiente respeitável e inclusivo, leia e siga nosso Código de Conduta.

Começando a Contribuir

Antes de começar, você precisará configurar algumas ferramentas e preparar seu ambiente de desenvolvimento.

Requisitos Gerais

  • Uma conta no GitHub
  • Git instalado
  • Um IDE (recomendado: Visual Studio Code)
  • Node.js v22.11.0 ou superior

Estrutura do Projeto

Este repositório contém dois submódulos:

  • backend → API e lógica de negócio
  • mobile → Aplicação mobile

Backend

Requisitos adicionais

  • MongoDB Community Server

Instalação

1. Clonar o repositório principal

git clone https://github.com/Bug-Busters-F/ProDesk
cd ProDesk

2. Inicializar submódulos

git submodule update --init --recursive

3. Acessar o backend

cd backend

4. Instalar dependências

npm install

5. Configurar variáveis de ambiente

cp .env.example .env

Edite o .env:

# DATABASE
MONGO_URI=mongodb://localhost:27017/prodesk

# APP
PORT=3000
NODE_ENV=development

Rodar o backend

npm run start:dev

Mobile

Requisitos adicionais

  • Java JDK 17
  • Android Studio

Instalação

1. Acessar o mobile

cd mobile

2. Instalar dependências

npm install

Rodar o mobile

npx expo start