Skip to content

docs: add README, MIT license, env example and build CI - #1

Merged
esdrassantos06 merged 1 commit into
mainfrom
docs/readme-license-ci
Nov 12, 2026
Merged

esdrassantos06 merged 1 commit into
mainfrom
docs/readme-license-ci

Conversation

@esdrassantos06

Copy link
Copy Markdown
Owner

Replaces the NestJS starter README with one that describes what the API does today: sign-up, login and JWT-protected routes, how to run it with Docker Compose, the endpoints with curl examples, and every environment variable the code reads.

Also adds:

  • LICENSE (MIT)
  • .env.example with the variable names and no real values
  • .github/workflows/ci.yml, which runs npm ci and npm run build on pull requests and pushes to main. Its build job is the required status check in the "Protect main" ruleset.

The Jest suites don't run yet (@nestjs/typeorm 11 is ESM and the specs use unmapped src/... imports), so CI only builds for now and the README says so. Tests and the CI step for them come in a separate PR.

@esdrassantos06
esdrassantos06 merged commit 9e8ec57 into main Nov 12, 2026
2 checks passed
@esdrassantos06
esdrassantos06 deleted the docs/readme-license-ci branch November 12, 2026 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant