Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.37 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 e fazer parte da nossa comunidade de desenvolvimento. Estamos ansiosos para ver suas contribuições e trabalhar juntos para tornar nosso projeto ainda melhor!

Código de Conduta

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

Começando a Contribuir

Contribuir para o nosso projeto é fácil e estamos ansiosos para receber suas contribuições! Antes de entrarmos nos passos para instalação da aplicação, você precisará configurar algumas ferramentas e preparar seu ambiente de desenvolvimento.

Aqui está o que você precisa:

  • Uma conta no GitHub
  • O version control system Git instalado.
  • Um IDE para o desenvolvimento. Recomendamos o Visual Studio Code.
  • O Node.js v20.x ou superior.
  • O backend do ClassiPy precisa estar rodando para que o frontend possa se comunicar com a API. Siga as instruções de instalação do repositório do backend.

Instalação

1. Clonar o Repositório

O primeiro passo é clonar o repositório do projeto para o seu ambiente local.

  1. Abra um terminal.

  2. Execute o seguinte comando para clonar o repositório:

    git clone https://github.com/Bug-Busters-F/ClassiPy-frontend

  3. Navegue até o diretório do projeto:

    cd ClassiPy-frontend

2. Instalar Dependências e Rodar o Projeto

Com o ambiente configurado, basta instalar as dependências do Node.js e iniciar o servidor de desenvolvimento.

  1. Instale as dependências do projeto:

    npm install

  2. Execute a aplicação em modo de desenvolvimento:

    npm run dev

3. Acesse a Aplicação

  • A aplicação frontend estará disponível em: http://localhost:5173 .
  • Certifique-se de que o backend também esteja rodando em http://localhost:8000 para que a comunicação funcione.