UNPKG

@ibernoh/arkanjs

Version:

Backend API generator with RBAC, CLI scaffolding, and built-in structure. Just install and run.

github.com/iberno/arkanjs

iberno/arkanjs

96 lines (76 loc) • 3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# 📘 Documentação ArkanJS ArkanJS é um gerador modular de APIs com Express e Sequelize, focado em segurança, escalabilidade e flexibilidade para aplicações modernas. --- ## 🔧 Estrutura Inicial - `initProject.js`: comando que cria a base do projeto com diretórios, arquivos e configuração padrão (SQLite) - Criação de `.env` com JWT secreto dinâmico - Geração automática do `database/database.sqlite` ### Comando: ```bash arkan init --install 🧠 CLI - Comandos Disponíveis 🔹 Inicialização bash arkan init --install # Cria estrutura do projeto arkan init --install --no-docs # Sem rota /doc 🔹 Geração de Recursos bash arkan generate:resource produto --fields nome:string,preco:float arkan generate:resource-auth tarefa --fields titulo:string,feito:boolean 🔹 Autenticação RBAC bash arkan generate:auth Cria modelos: User, Role, Permission, RoleUser, RolePermission Gera rota /login pública Cria usuário admin@arkan.dev com senha secret Associa role dashboard e permissão manage_users 🔹 Configuração de Ambiente bash arkan generate:env --sqlite arkan generate:env --postgresql arkan generate:env --mysql arkan generate:env --mongo arkan generate:env --help 🔐 Proteção de Rotas Rotas geradas via generate:resource-auth são protegidas por: authMiddleware: valida token JWT requireRole("dashboard"): cargo obrigatório Prontas para expandir com requirePermission() 📂 Estrutura de Pastas txt ├── src │ ├── config/ # Conexão Sequelize │ ├── controllers/ # Lógica dos recursos │ ├── models/ # Modelos Sequelize │ ├── routes/ # Arquivos de rotas │ ├── middlewares/ # Autenticação e permissões │ ├── roles/ # RBAC: Role + associação │ ├── permissions/ # RBAC: Permission + associação │ └── server.js # Ponto inicial da API ├── scripts/ # Scripts CLI ├── templates/ # Arquivos .ejs para geração dinâmica ├── database/ # SQLite local ├── .env # Variáveis de ambiente (não versionado) ├── .env.example # Modelo de ambiente ├── README.md # Visão geral do projeto ├── Doc.md # Essa documentação 🔍 Tecnologias Utilizadas Camada Tecnologia Servidor & Rotas Express.js ORM Sequelize Autenticação jsonwebtoken CLI Commander, Inquirer Templates EJS Configuração .env dotenv Utilitários Módulos nativos (fs, path, crypto) Formatação Dev Prettier Futuro Swagger, ESLint, Mongoose ✅ Usuário Inicial Email: admin@arkan.dev Senha: secret Cargo: dashboard Permissão: manage_users Use essa conta para logar via /login e acessar recursos protegidos. ✨ Conclusão Este projeto está pronto para crescer com recursos, painéis administrativos, controle de acesso dinâmico e documentação interativa. Construa, conecte e escale com ArkanJS 🚀