create-rubrica 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -0
- package/dist/index.js +1584 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# create-rubrica
|
|
2
|
+
|
|
3
|
+
CLI para criar e configurar projetos [Rubrica](https://github.com/matheusmierzwa/rubrica) — sistema de portfólio profissional com React + Convex.
|
|
4
|
+
|
|
5
|
+
## Instalação
|
|
6
|
+
|
|
7
|
+
Não é necessário instalar globalmente. Use diretamente via `pnpm create` ou `npx`:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm create rubrica meu-portfolio
|
|
11
|
+
# ou
|
|
12
|
+
npx create-rubrica meu-portfolio
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Comandos
|
|
16
|
+
|
|
17
|
+
### `pnpm create rubrica <nome-do-projeto>`
|
|
18
|
+
|
|
19
|
+
Cria um novo projeto Rubrica a partir do template mais recente. O assistente interativo coleta:
|
|
20
|
+
|
|
21
|
+
- **Identidade** — nome do site, URL, descrição, autor, email, Twitter/X handle, idioma
|
|
22
|
+
- **Visual** — layout (sidebar / topbar / centered), tema (cyberpunk / minimal / editorial / forest / personalizado), fonte principal, fonte mono, border radius
|
|
23
|
+
- **Funcionalidades** — plugins ativos (blog, portfólio, currículo, etc.)
|
|
24
|
+
- **Setup** — inicializar git, instalar dependências
|
|
25
|
+
|
|
26
|
+
Ao final, os arquivos gerados incluem:
|
|
27
|
+
- `rubrica.config.ts` — identidade e aparência em build-time
|
|
28
|
+
- `rubrica.json` — estado da CLI (versionado)
|
|
29
|
+
- `src/components/Layout.tsx` e arquivos de navegação do layout escolhido
|
|
30
|
+
- `src/index.css` — tema CSS aplicado
|
|
31
|
+
- `convex/pluginRegistry.ts` — plugins configurados
|
|
32
|
+
|
|
33
|
+
### `rubrica config`
|
|
34
|
+
|
|
35
|
+
Reconfigura um projeto Rubrica existente. Execute dentro do diretório do projeto:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
rubrica config
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Permite reconfigurar:
|
|
42
|
+
- **Identidade** — atualiza `rubrica.config.ts` com novos dados
|
|
43
|
+
- **Aparência** — altera tema, fontes e radius; atualiza CSS e `rubrica.json`
|
|
44
|
+
- **Layout** — troca o shell de navegação (⚠ sobrescreve customizações manuais)
|
|
45
|
+
- **Plugins** — ativa ou desativa plugins no `convex/pluginRegistry.ts`
|
|
46
|
+
|
|
47
|
+
### `rubrica update`
|
|
48
|
+
|
|
49
|
+
Atualiza um projeto Rubrica para a versão mais recente do template (Fase 3 — em desenvolvimento).
|
|
50
|
+
|
|
51
|
+
## Estrutura gerada
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
meu-portfolio/
|
|
55
|
+
├── rubrica.config.ts ← identidade e aparência (editável)
|
|
56
|
+
├── rubrica.json ← estado da CLI (versionado)
|
|
57
|
+
├── src/
|
|
58
|
+
│ ├── components/
|
|
59
|
+
│ │ ├── Layout.tsx ← shell do layout escolhido
|
|
60
|
+
│ │ └── Sidebar.tsx ← ou Navbar.tsx / Footer.tsx
|
|
61
|
+
│ └── index.css ← tema CSS
|
|
62
|
+
├── convex/
|
|
63
|
+
│ └── pluginRegistry.ts ← plugins configurados
|
|
64
|
+
└── index.html ← meta tags preenchidas
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Pós-instalação
|
|
68
|
+
|
|
69
|
+
Após `pnpm create rubrica`:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
cd meu-portfolio
|
|
73
|
+
|
|
74
|
+
# 1. Suba o backend Convex (deixe rodando)
|
|
75
|
+
npx convex dev
|
|
76
|
+
|
|
77
|
+
# 2. Em outro terminal, inicie o frontend
|
|
78
|
+
pnpm dev
|
|
79
|
+
|
|
80
|
+
# 3. Acesse http://localhost:3000 e crie seu usuário root em /login
|
|
81
|
+
# (com BOOTSTRAP_ALLOWED=true no Convex Dashboard)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Licença
|
|
85
|
+
|
|
86
|
+
MIT
|