Back-end da API instabyte

Este é o repositório do back-end do projeto.

IMPORTANTE: É necessário ter o Node.js instalado em seu computador antes de executar os comandos de instalação e execução do projeto. Versão recomendada: v20.x.x.

PASSO 1: Baixe o código do projeto:

Opção 1 - Clonando o repositório para o seu perfil no GitHub

Para utilizar essa opção é necessário ter o Git instalado e configurado em seu computador. Caso não esteja instalado ou você não tenha certeza, prossiga com a opção 2 e baixe o .zip do projeto.

1. Faça o fork do projeto clicando no botão Fork na parte superior direita da página;
2. Faça o clone do repositório para seu computador:

• Clique no botão <> Code e copie o endereço remoto do repositório;
• Abra o terminal, navegue até a pasta raiz onde deseja baixar o projeto e execute o comando git clone <endereço remoto>;
• Você pode acessar a pasta do projeto direto pelo Visual Studio Code, clicando em File > Open Folder e selecionando a pasta do projeto.

Opção 2 - Baixando um arquivo .zip

1. clique no botão <> Code e, em seguida, no botão Download ZIP;
2. uma pasta zipada será baixada para a pasta de downloads determinada pelo seu navegador;
3. descompacte os arquivos clicando no ícone da pasta zipada e transfira os arquivos para a pasta de projetos de sua preferência.

PASSO 2: Instale o projeto:

Opção 1 - Utilizando o terminal do Visual Studio Code

1. Abra a pasta do projeto no Visual Studio Code clicando em File > Open Folder e selecionando a pasta do projeto;
2. Clique em Terminal > New Terminal no menu superior do Visual Studio Code. O terminal deve abrir já direcionando para a pasta correta do projeto;
3. Execute o comando npm install e aguarde a finalização.

Opção 2 - Utilizando outros terminais

1. Abra o terminal de sua preferência e navegue até a pasta do projeto, utilizando os comandos de navegação como cd <pasta>;
2. Com o prompt apontando para a raiz da pasta do projeto, execute o comando npm install e aguarde a finalização.

PASSO 3: Crie o documento .env:

O arquivo .env é essencial para configurar as variáveis de ambiente utilizadas no projeto. Essas variáveis ajudam a manter informações sensíveis, como chaves de API e strings de conexão com o banco de dados, fora do código-fonte principal, oferecendo maior segurança e flexibilidade.

A STRING_CONEXAO e uma string dada pelo mogoDB para conexão, foi ultilizado o Atlas mogoDB

A GEMINI_API_KEY e a KEY da api da Gemini.

PASSO 4: Execute o projeto para subir o servidor local:

Acesse o terminal (do Visual Studio Code ou outro), certifique-se que esteja exibindo a pasta correta do projeto e execute o comando npm run dev. O terminal deverá retornar:

> dev
> node --watch --env-file=.env server.js

Conectado ao cluster do banco de dados...
Conectado ao MongoDB Atlas com sucesso!
Server ativo...
✨ Built in xxxms

O projeto estará disponível no endereço http://localhost:3000 e você poderá acessá-lo no navegador de sua preferência.