Boilerplate Service

A boilerplate typescript micro service that runs as docker or lambda. Click "Use this Template" to use this for your service.

Key Stack Components

Authentication and Authorization via UE Auth
Configurable MongoDB connection
oData support for queries
JSON Patch implemented for updates with mongodb
OpenAPI (swagger) and Swagger UI (/swagger)
Automatic API Documentation Generated via ReDoc (/api)
Automatic schema validation using the OpenAPI spec built in as middleware
Automatic Type definitions using OpenAPI spec (yarn swag-spec SWAGGER-OBJEC TYPE-NAME)
Error handling via @hapi/Boom
Works with Docker or Lambda
Jest test harness

Have other ideas? Feel free to PR!

If you'd rather use a different database or ODM, the following modifications are necessary:

change connection.ts to the appropriate DB
validate that slsapp and start both correctly implement connection.ts
in each of your api/resources, change the dal.ts file to access the new DB using the new ODM/ORM

Click "Use this Template" at the top of the repository and setup your project
clone your project to your machine
start mongodb on port 27017
- I find the easiest way to do this is via docker in a terminal
- docker run -p 27017:27017 mongo
Copy ./.env_ci to ./.env and modify env.dev.json to set runtime configuration data
yarn test (will install dependencies and build first)
yarn dev
navigate to localhost:3000

Name		Name	Last commit message	Last commit date
Latest commit History 153 Commits
.env_ci		.env_ci
.github/workflows		.github/workflows
public		public
src		src
views		views
.dockerignore		.dockerignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
jest.config.js		jest.config.js
openApiTypeGenerator.ts		openApiTypeGenerator.ts
package.json		package.json
serverless.yaml		serverless.yaml
swagger.yaml		swagger.yaml
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock