https://github.com/fnoquiq/projectsaas-api
[SaaS] Sistema para organização de times e projetos
https://github.com/fnoquiq/projectsaas-api
adonis-framework commit-lint husky saas
Last synced: 6 months ago
JSON representation
[SaaS] Sistema para organização de times e projetos
- Host: GitHub
- URL: https://github.com/fnoquiq/projectsaas-api
- Owner: fnoquiq
- Created: 2020-02-17T22:09:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-01T21:26:14.000Z (almost 6 years ago)
- Last Synced: 2025-07-05T03:11:44.666Z (7 months ago)
- Topics: adonis-framework, commit-lint, husky, saas
- Language: JavaScript
- Homepage:
- Size: 489 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Adonis SaaS API
Estudo da arquitetura SaaS usando o framework AdonisJS
## :hammer: Configurar a aplicação:
- O SGDB desta aplicação é o PostgreSQL, para isso, basta executar em seu terminal o seguinte comando: `sudo docker run --name postgresbarber -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -d postgres`. Este comando será responsável por levantar um container docker todo configurado para o uso do PostgreSQL;
- Está aplicação utiliza o Redis para organizar os emails a serem enviados. Desta forma basta executar em seu terminal o seguinte comando: `sudo docker run --name redis -p 6379:6379 -d -t redis:alpine`. Este comando será responsável por levantar um container docker todo configurado para o uso do Redis;
- Copie o arquivo `.env.example` e renomeie a cópia para `.env.`. Após isso, preencha as informações necessárias dele.
- Execute o comando `yarn` para instalar todas as dependências necessárias do projeto.
- Para rodar as migrations, execute `adonis migration:run`. **Certifique-se de que o PostgreSQL esteja configurado e iniciado**.
---
## :horse_racing: Iniciar a aplicação:
- Execute `adonis serve --dev` para levantar a API.
- Execute `adonis kue:listen` para levantar a fila.
---
## :dart: Rotas da API:
- Para verificar as rotas disponíveis desta api, execute no terminal `adonis route:list`.
---
## :package: Importar configurações do Insomnia
[](https://insomnia.rest/run/?label=adonisSaaS-api&uri=https%3A%2F%2Fgithub.com%2Ffnoquiq%2FadonisSaaS-api%2Fblob%2Fmaster%2Finsomnia.json)