API do software WhyApp, desenvolvido pela Bear System © | 2023
O projeto é feito utilizando o framework NestJS
Siga estes passos corretamente para instalar, testar e modificar a cópia desta API
- Obtenha um banco de dados POSTGREE: Antes de tudo, você deve ter um banco de dados rodando. Nós utilizamos para testes o Render para hospedar.
- Configurar as variáveis de ambiente: Você deve renomear o arquivo ./.env-exemple para .env apenas.
- Conecte-se ao banco de dados POSTGREE: Obtenha a URL de conexão e modifique a chave DATABASE_URL no arquivo ./.env, assim como mostrado abaixo.
DATABASE_URL="postgresql://docker:docker@localhost:5434/docker?schema=public" Nota: Como pode ver, utilizamos um container docker do Postgree, a imagem que utilizamos foi a bitnami/postgresql:latest direto do docker hub
- Finalize a configuração: Preencha as chaves obrigatórias restantes do arquivo .env
- Instale os pacotes necessários: Faça as instalações das dependências com o comando
yarn install- Execute a aplicação: Pronto! Agora você pode executar a aplicação localmente com o comando:
yarn start:devNota: Repare que estamos executando como dev, o que habilita o reinicio automático em caso de alteração no código, em produção você deve executar com start:prod. Confira os scripts no arquivo package.json
Ao seguir o passo-a-passo, a aplicação deve estar rodando corretamente. Assim você pode acessar através do seu localhost na porta 3000 e receber a mensagem: API WhyApp Backend - Rodando...
Você pode contribuir neste projeto livremente abrindo um Pull Request após fazer o Fork deste repositório.
Este projeto está sob a Licença MIT - consulte o arquivo LICENSE para mais detalhes.