An API for use by Example
An API for for use by Example
https://example.com/api-docs/index.html
https://example.com/app-docs/index.htmlm
https://example.com/sdk-docs/index.html
This project requires Docker
# Install dependencies
$ npm install
# Build containers
$ make dev-build
$ make dev-up
Note: this will run with --watch
enabled, so it will automatically detect changes and auto-reload the environment
$ npm run start:prod
# integration tests
$ make dev-shell-node-worker
# Once inside the container
$ sh test.sh
# Create migration - name must be in PascalCase
npm run typeorm migration:create -- -n <NameOfMigration>
# Run migrations
npm run typeorm migration:run
# Create - entity name must be in camelCase and you must suffix the name with ".entity"
npm run typeorm entity:create -- -n <entityName>.entity
# Create controller
nest g controller controllers/<ControllerName>
# Create module
nest g module modules/<ModuleName>
# Create service
nest g service services/<ServiceName>
For any questions please reach out to First Last
First you need to log in into GitHub's Docker registry. This will require you to log in using a PAT (personal access
token) that has read:packages
permissions.
# Docker login
docker login ghcr.io -u <GitHub username> -p <GitHub PAT>
Then you can pull the image
docker pull ghcr.io/username/example:latest