{"id":16471824,"url":"https://github.com/theboeffect/boilerplate","last_synced_at":"2025-10-27T14:30:54.296Z","repository":{"id":40574062,"uuid":"247373595","full_name":"theBoEffect/boilerplate","owner":"theBoEffect","description":"This is a boilerplate ESM, TypeScript, mongoose, openapi, etc. microservice template that I use for my work. It can be run as a docker container or a lambda function.","archived":false,"fork":false,"pushed_at":"2024-03-17T18:04:43.000Z","size":6011,"stargazers_count":3,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-03-17T19:24:16.674Z","etag":null,"topics":["boilerplate","docker","express","lambda","microservice","mongodb","nodejs","openapi","serverless","swagger","typescript"],"latest_commit_sha":null,"homepage":"https://theboeffect.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theBoEffect.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-03-15T00:11:25.000Z","updated_at":"2024-03-17T19:24:18.744Z","dependencies_parsed_at":"2023-02-18T06:45:45.740Z","dependency_job_id":"7369b9ab-2355-414b-8458-7efb11e2b84b","html_url":"https://github.com/theBoEffect/boilerplate","commit_stats":null,"previous_names":[],"tags_count":33,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fboilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fboilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fboilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fboilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theBoEffect","download_url":"https://codeload.github.com/theBoEffect/boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219861094,"owners_count":16556007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","docker","express","lambda","microservice","mongodb","nodejs","openapi","serverless","swagger","typescript"],"created_at":"2024-10-11T12:14:51.430Z","updated_at":"2025-10-27T14:30:53.870Z","avatar_url":"https://github.com/theBoEffect.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate Service\n\nA boilerplate typescript micro service that runs as docker or lambda. Click \"Use this Template\" to use this for your service.\n\n[![CI](https://github.com/theBoEffect/boilerplate/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/theBoEffect/boilerplate/actions/workflows/main.yml)\n\n#### follow me:\n* [twitter](https://twitter.com/theboeffect)\n* [linkedIn](https://www.linkedin.com/in/bmotlagh/)\n* [instagram](https://www.instagram.com/theboeffect/)\n\n## Key Stack Components\n\n* TypeScript\n* ESM\n* Express\n* Mongoose -\u003e MongoDB\n* Serverless-http\n* openAPI/Swagger\n* Express-OpenAPI-Validate\n* @hapi/boom\n* oData API query\n* JSON Patch\n* Passport (see libs in package.json)\n* Jest\n\n## Features\n\n* Authentication and Authorization via [UE Auth](https://ueauth.com)\n* Configurable MongoDB connection\n* oData support for queries\n* JSON Patch implemented for updates with mongodb\n* OpenAPI (swagger) and Swagger UI (/swagger)\n* Automatic API Documentation Generated via ReDoc (/api)\n* Automatic schema validation using the OpenAPI spec built in as middleware\n* Automatic Type definitions using OpenAPI spec (yarn swag-spec SWAGGER-OBJEC TYPE-NAME)\n* Error handling via @hapi/Boom\n* Works with Docker or Lambda\n* Jest test harness\n\nHave other ideas? Feel free to PR!\n\n### oData Spec\n\nhttps://www.odata.org/documentation/\n\n### JSON Patch\n\nhttp://jsonpatch.com/\n\n### DB\n\nIf you'd rather use a different database or ODM, the following modifications are necessary:\n\n* change connection.ts to the appropriate DB\n* validate that slsapp and start both correctly implement connection.ts\n* in each of your api/resources, change the dal.ts file to access the new DB using the new ODM/ORM\n\n## Quickstart Run\n\n* Click \"Use this Template\" at the top  of the repository and setup your project\n* clone your project to your machine\n* start mongodb on port 27017\n    * I find the easiest way to do this is via docker in a terminal\n    * docker run -p 27017:27017 mongo\n* Copy ./.env_ci to ./.env and modify env.dev.json to set runtime configuration data\n* yarn test (will install dependencies and build first)\n* yarn dev\n* navigate to localhost:3000\n\n### Configure For Your Service\n\n* Update the following in package.json\n    * name\n    * author\n    * person\n    * description\n    * homepage (your website or project website)\n    * logo (your logo or project logo url)\n* Do the above quickstart now...\n* Add src/api resources using the [logging example](./src/api/logging)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheboeffect%2Fboilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheboeffect%2Fboilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheboeffect%2Fboilerplate/lists"}