Certifique-se de que tenha o git e NodeJs instalado no seu sistema para usar os comandos git, caso não tenha, instale a partir do link: https://git-scm.com/downloads
Copie o código a seguir:
https://github.com/CauaYves/cult-api.git
No seu sistema operacional, abra o explorador de arquivos e entre no terminal a partir dessa pasta, execute o código de clonagem, e após o download ser concluído, o projeto estará na pasta em que você acessou.
Entre no pasta de projeto e execute o comando de instalação de dependências.
npm install
Para servir o projeto, é necessário adicionar as variáveis de ambiente listadas no arquivo .env.example, são elas:
PORT=
DATABASE_URL=
NODE_ENV=
JWT_SECRET=
PORT: numero da porta que rodará o projeto
DATABASE_URL: url de conexão com o banco de dados PostgreSQL
NODE_ENV: modo de operação da aplicação, "production" | "development"
JWT_SECRET: segredo jwt para codificação dos tokens
Com as dependências instaladas, e as variáveis aplicadas, o projeto estará pronto para ser usado, rode o comando de execução em desenvolvimento:
npm run dev
O servidor exibirá a mensagem: ✅Server listening on port 4000
Enquanto a aplicação está sendo executada, cheque o status da aplicação no navegador a partir da URL:
http://localhost:porta/health
Para conhecer mais sobre as rotas da aplicação e entender o funcionamento e uso, siga para a documentação de uso na rota http://localhost:{porta}/api-docs/ troque a {porta} pela porta em que o servidor está rodando atualmente.
criador: https://github.com/CauaYves