Backend do Orange Portfolio, um MVP desenvolvido pelo Squad 4 da 5ª edição do Programa de Formação da Orange Juice em parceria com a FCamara, desempenha um papel crucial ao fornecer os serviços e funcionalidades necessários para suportar a operação e a interação dos usuários na plataforma, sendo ele a base que sustenta toda a experiência do usuário, garantindo um funcionamento suave e eficaz da aplicação.
- Cadastro de usuário
- Login com o Google
- Login com email e senha
- Cadastro de Projetos
- Edição de projetos
- Exclusão de projetos
- Descoberta de novos projetos
- Filtragem projetos por categorias
1º passo - Depois de clonar o projeto, renomeie o arquivo chamado .env.example
para apenas .env
, e o preencha com as informações que se pede:
# A porta onde o backend estará onvindo as requisições.
SERVER_PORT=
# A url de conexão com o seu banco de dados.
DB_URL=
# O tempo de expiração do token usado no login dos usuários. Ex: 7d, 1h, 10s
JWT_EXPIRATION_DATE=
# A string secreta que será usada para gerar os tokens
JWT_SECRET_KEY=
# O emissor do token. Normalmente se coloca algo remete à você ou ao nome da sua aplicação.
JWT_ISSUER=
# O destinatário do token, representa a aplicação que irá usá-lo.
JWT_AUDIENCE=
# O ID da aplicação criada no site do Imgur onde ficarão armazenadas as imagens enviadas para dentro do projeto.
Client_ID_Imgur=
# Dominio onde está hospedado o client (frontend)
Client_Domain=
# Dominio onde está hospedado este projeto
Host_Domain=
# ID do clinete imgur para upload das imagens
Client_ID_Imgur=
# ID do cliente do google para o login (oauth with google)
Client_ID_Google=
# Secret key encontrada no mesmo lugar do ID, e para o mesmo propósito
Client_Secret_Google=
2º passo - Com o terminal aberto na raiz do projeto, execute o comando npm install
para que todas as dependências sejam baixadas.
3º passo - No mesmo terminal, execute npm run start:dev
para que o projeto seja executado em modo de desenvolvimento.
Para visualizar a documentação de todas as rotas do projeto usando o swagger, clique aqui