Repository navigation
docs: add README, MIT license, env example and build CI - #1
Merged
Merged
Conversation
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.
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.examplewith the variable names and no real values.github/workflows/ci.yml, which runsnpm ciandnpm run buildon pull requests and pushes tomain. Itsbuildjob is the required status check in the "Protect main" ruleset.The Jest suites don't run yet (
@nestjs/typeorm11 is ESM and the specs use unmappedsrc/...imports), so CI only builds for now and the README says so. Tests and the CI step for them come in a separate PR.