https://github.com/bear-system-dev/whyapp-backend
https://github.com/bear-system-dev/whyapp-backend
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bear-system-dev/whyapp-backend
- Owner: bear-system-dev
- License: mit
- Created: 2024-02-05T03:05:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-11T22:50:24.000Z (almost 2 years ago)
- Last Synced: 2025-04-27T00:33:00.252Z (about 1 year ago)
- Language: TypeScript
- Size: 717 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WhyApp-Backend
### API do software [WhyApp](https://github.com/bear-system-dev/whyapp-frontend), desenvolvido pela [Bear System © | 2023](https://bearsystem.onrender.com)
## Depende
- [NodeJs LTS (v20.11.0)](https://nodejs.org/en)
- Yarn
O projeto é feito utilizando o framework [NestJS](https://docs.nestjs.com)
## Instalação
Siga estes passos corretamente para instalar, testar e modificar a cópia desta API
1. **Obtenha um banco de dados POSTGREE**: Antes de tudo, você deve ter um banco de dados rodando. Nós utilizamos para testes o [Render](https://render.com) para hospedar.
2. **Configurar as variáveis de ambiente**: Você deve renomear o arquivo **./.env-exemple** para **.env** apenas.
3. **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.
```bash
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**
4. **Finalize a configuração**: Preencha as chaves obrigatórias restantes do arquivo **.env**
5. **Instale os pacotes necessários**: Faça as instalações das dependências com o comando
```bash
yarn install
```
6. **Execute a aplicação**: Pronto! Agora você pode executar a aplicação localmente com o comando:
```bash
yarn start:dev
```
>**Nota:** 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](http:127.0.0.1:3000) e receber a mensagem: **_API WhyApp Backend - Rodando..._**
## Contribuição / Contributing
Você pode contribuir neste projeto livremente abrindo um Pull Request após fazer o Fork deste repositório.
## License
Este projeto está sob a Licença MIT - consulte o arquivo [LICENSE](https://github.com/bear-system-dev/whyapp-backend/blob/dev/LICENSE) para mais detalhes.