Repository navigation
docs: licença MIT, um quickstart que funciona, e as limitações por escrito - #26
Merged
Merged
Conversation
…crito Preparação para o repositório virar público. **Licença.** MIT, e o `package.json` sai de `UNLICENSED`. Um repositório público sem licença é, tecnicamente, todos os direitos reservados. **Quickstart.** "Rodando o projeto" era `pnpm install` e `start:dev` — quem clonasse não conseguia subir nada. Agora tem os seis passos reais: versões, `.env`, `prisma migrate deploy`, `prisma db seed` (sem ele não existe papel para um usuário novo receber e o registro falha), catálogo de demonstração, e onde a Swagger UI fica. Inclui o que o cadastro deliberadamente não dá — verificar e-mail e promover a admin — como SQL, porque hoje é só assim. Diz também quais variáveis são mesmo obrigatórias em `development`: duas. As do Google podem ficar vazias, que é o que o `isGoogleConfigured` já prevê. **Limitações.** Seção nova, com o que a v1 não tem: rota de gestão de acesso, ciclo de vida de conta, `/auth/me`, e as permissões de cupom que existem no catálogo sem feature atrás. Integrar sem saber disso é descobrir tarde. **Contagem de rotas.** Dizia 39; são 38 caminhos e 46 operações. **Testes.** A seção não avisava que a e2e dá `TRUNCATE` no banco para onde o `DATABASE_URL` aponta, nem citava o `e2e:setup`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preparação para o repositório virar público.
Licença
MIT, e o
package.jsonsai deUNLICENSED. Um repositório público sem licençaé, tecnicamente, todos os direitos reservados — ninguém pode usar, e é o
primeiro sinal que alguém revisando o projeto procura.
Quickstart que funciona
"Rodando o projeto" era
pnpm installseguido depnpm start:dev. Quemclonasse não conseguia subir: nada dizia que precisa de Postgres, de
.env,de migration, nem de seed.
Agora são seis passos verificados contra o código:
cp .env.example .env— e quais variáveis são mesmo obrigatórias emdevelopment: duas,DATABASE_URLeJWT_SECRETprisma migrate deployprisma db seed— sem ele não existe papel para um usuário novo recebere o registro falha, que era a armadilha mais provável
pnpm demo:catalog, opcionalpnpm start:dev, e a Swagger UI em/docsMais o que o cadastro deliberadamente não dá — verificar e-mail e promover
a admin — como SQL, porque hoje é o único jeito.
As duas variáveis do Google podem ficar vazias:
isGoogleConfiguredjá prevêisso e o
GET /auth/googleresponde 503 em vez de quebrar o boot. O README nãodizia, e elas estão vazias no
.env.example, então parecia um erro.Seção "Limitações"
Nova, e a mais útil para quem for integrar. O que a v1 não tem:
permissões, três papéis,
user_permissions, ojwt.strategysomando os doisem toda requisição. O que não existe é endpoint: nenhuma das 38 rotas lista
usuário, troca papel ou concede permissão. Hoje é
UPDATEno banco./auth/me— o token carrega só{ sub }.coupons.*existem no catálogo sem feature atrás.Correções
TRUNCATEno banco para onde oDATABASE_URLaponta, nem citava opnpm e2e:setup.Verificação
Só documentação, licença e dois campos do
package.json— nenhum código deruntime mudou. Cada afirmação nova do README foi conferida contra o código:
getOrThrowde cada variável, o gateNODE_ENVdo Stripe empayments.module.ts, oisGoogleConfiguredemgoogle.strategy.ts, oseeddoprisma.config.ts, e a contagem de rotas peloopenapi.json.