https://github.com/diegoporfirio01/saas-boilerplate
Boilerplate with Next.js 15, Fastfy, Open API (Swagger) and Github Login
https://github.com/diegoporfirio01/saas-boilerplate
fastify git-actions github-login intercepting-routes next15 parallel-routes server-actions shadcn swagger
Last synced: 5 months ago
JSON representation
Boilerplate with Next.js 15, Fastfy, Open API (Swagger) and Github Login
- Host: GitHub
- URL: https://github.com/diegoporfirio01/saas-boilerplate
- Owner: DiegoPorfirio01
- Created: 2024-06-23T00:55:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T17:08:19.000Z (10 months ago)
- Last Synced: 2025-02-17T02:23:12.373Z (8 months ago)
- Topics: fastify, git-actions, github-login, intercepting-routes, next15, parallel-routes, server-actions, shadcn, swagger
- Language: TypeScript
- Homepage: https://saas-next15.vercel.app/
- Size: 319 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Projeto Full Stack com Fastify, Prisma, Next.js 15 e Docker 🚀
## Descrição 📝
Este projeto é uma aplicação full stack composta por uma API construída com Fastify e Prisma, e uma interface frontend usando Next.js 15. Além disso, utilizamos Docker para criar um ambiente de desenvolvimento consistente e isolado. A aplicação frontend faz uso de cache e componentes de servidor para otimização de desempenho e SEO.
**Documentação OPEN API (SWAGGER)** https://prod-api.saas-next15-rbac.duckdns.org/docs/static/index.html
## Tecnologias Utilizadas 🛠️
### Backend 🔙
- **Node.js**: Ambiente de execução JavaScript no servidor.
- **Fastify**: Framework web rápido e eficiente para Node.js.
- **Prisma**: ORM e gerenciador de banco de dados.
- **Swagger**: Ferramenta para documentação de APIs.
- **CASL**: Biblioteca para controle de acesso baseado em permissões (RBAC).
- **Prisma**: ORM.
- **ZOD** : Validações.
- **TypeScript**: Superset de JavaScript que adiciona tipagem estática.
### Frontend 🔜
- **Next.js 15**: Framework React para aplicações web modernas.
- Parallel Routes
- Intercepting Routes
- Server Actions
- Zod
- Shadcn
- ...
- **React**: Biblioteca para construção de interfaces de usuário.
- **React Query**: Requisições Assíncronas e Cache
- **Cache**: Implementação de cache para otimização de desempenho.
- **Server Components**: Uso de componentes de servidor para renderização, melhor performance e otimização para SEO.
### Contêinerização 🐳
- **Docker**: Plataforma para desenvolvimento, envio e execução de aplicações em contêineres.
### Pré-requisitos 📋
- Node.js
- pnpm (Package manager)
- Docker
### Passos para Configuração ⚙️
1. **Clone o repositório**:
```bash
git clone https://github.com/DiegoPorfirio01/saas-next-festfy.git
cd saas-next-festfy
```
2. **Instale as dependências na pasta raiz**:
```bash
pnpm install
```
3. **Gere o cliente Prisma**:
```bash
cd apps/api
pnpm prisma generate
```
4. **Execute o ambiente de desenvolvimento com Docker**:
(na raiz do projeto execute)
```bash
docker-compose up -d
```
6. **Acesse a aplicação**:
- API: `http://localhost:3333`
- Documentação da API: `http://localhost:3333/docs`
- Frontend: `http://localhost:3000`
## Permissões RBAC com CASL 🔐
Utilizamos a biblioteca `@casl/ability` para gerenciar permissões baseadas em funções (RBAC). As habilidades e permissões são definidas de acordo com as regras de negócios e aplicadas aos recursos da API para garantir acesso seguro e controlado.
### Permissions table
| | Administrator | Member | Billing | Anonymous |
| ------------------------ | ------------- | ------ | ------- | --------- |
| Update organization | ✅ | ❌ | ❌ | ❌ |
| Delete organization | ✅ | ❌ | ❌ | ❌ |
| Invite a member | ✅ | ❌ | ❌ | ❌ |
| Revoke an invite | ✅ | ❌ | ❌ | ❌ |
| List members | ✅ | ✅ | ✅ | ❌ |
| Transfer ownership | ⚠️ | ❌ | ❌ | ❌ |
| Update member role | ✅ | ❌ | ❌ | ❌ |
| Delete member | ✅ | ⚠️ | ❌ | ❌ |
| List projects | ✅ | ✅ | ✅ | ❌ |
| Create a new project | ✅ | ✅ | ❌ | ❌ |
| Update a project | ✅ | ⚠️ | ❌ | ❌ |
| Delete a project | ✅ | ⚠️ | ❌ | ❌ |
| Get billing details | ✅ | ❌ | ✅ | ❌ |
| Export billing details | ✅ | ❌ | ✅ | ❌ |
> ✅ = allowed
> ❌ = not allowed
> ⚠️ = allowed w/ conditions
#### Conditions
- Only owners may transfer organization ownership;
- Only administrators and project authors may update/delete the project;
- Members can leave their own organization;
## Server Components e Otimização para SEO 🌐
Utilizamos Server Components no Next.js 15 para renderização no servidor, o que melhora significativamente o desempenho e a experiência do usuário. Além disso, a renderização no servidor proporciona uma melhor otimização para motores de busca (SEO), garantindo que o conteúdo da aplicação seja facilmente indexado pelo Google e outros buscadores.
## Contribuição 🤝
Sinta-se à vontade para contribuir com este projeto. Para isso, siga os passos abaixo:
1. Faça um fork do repositório.
2. Crie uma nova branch: `git checkout -b minha-feature`.
3. Faça suas alterações e commit: `git commit -m 'Minha nova feature'`.
4. Envie para a branch original: `git push origin minha-feature`.
5. Crie um pull request.
## Licença 📄
Este projeto está licenciado sob a licença MIT.
Estamos animados para construir esta aplicação e esperamos que você também esteja! Se tiver dúvidas ou sugestões, sinta-se à vontade para abrir uma issue no repositório. Vamos criar algo incrível juntos! 🌟