{"id":46914204,"url":"https://github.com/amin-abbasi/typescript-boilerplate","last_synced_at":"2026-03-11T02:27:52.697Z","repository":{"id":65815385,"uuid":"271243335","full_name":"amin-abbasi/typescript-boilerplate","owner":"amin-abbasi","description":"A Typescript boilerplate using Express, MongoDB, MySQL, Redis, Docker, OpenAPI and more ...","archived":false,"fork":false,"pushed_at":"2026-03-02T22:11:04.000Z","size":1065,"stargazers_count":42,"open_issues_count":0,"forks_count":10,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-03T01:14:35.784Z","etag":null,"topics":["boilerplate","boilerplate-template","docker","docker-compose","express","expressjs","mongodb","mysql","nodejs","openapi","redis","swagger","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","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/amin-abbasi.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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-10T10:08:10.000Z","updated_at":"2026-03-02T22:11:08.000Z","dependencies_parsed_at":"2023-02-22T02:45:38.312Z","dependency_job_id":"e3f0ad77-f932-4738-88d5-fe0b4ff58dd9","html_url":"https://github.com/amin-abbasi/typescript-boilerplate","commit_stats":null,"previous_names":["amin-abbasi/typescript-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/amin-abbasi/typescript-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amin-abbasi%2Ftypescript-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amin-abbasi%2Ftypescript-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amin-abbasi%2Ftypescript-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amin-abbasi%2Ftypescript-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amin-abbasi","download_url":"https://codeload.github.com/amin-abbasi/typescript-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amin-abbasi%2Ftypescript-boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30367814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T21:41:54.280Z","status":"online","status_checked_at":"2026-03-11T02:00:07.027Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","boilerplate-template","docker","docker-compose","express","expressjs","mongodb","mysql","nodejs","openapi","redis","swagger","typeorm","typescript"],"created_at":"2026-03-11T02:27:52.490Z","updated_at":"2026-03-11T02:27:52.676Z","avatar_url":"https://github.com/amin-abbasi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micro-service Boilerplate\n\nThis is a micro-service boilerplate written with Typescript and implemented using [Node.js] (Express), [MongoDB] (Mongoose), [Redis], Jest, Socket.io and OpenAPI (Swagger). You can use it to initiate your own server-side application.\n\n## [Name of the application] API\n\nYour can write your complete description about this app here...\n\n### Prerequisites / Setting up for first time\n\nWhat you need to install before running this app\nex: Make sure you have git, nvm, npm, [Node.js] installed\n\n### Get the project and install npms\n\n- Clone the project `git clone https://github.com/amin-abbasi/typescript-boilerplate.git`\n- Go to the project folder and run: `npm i`\n\n### Database Setup\n\n- Install [MongoDB] and [Redis] in your system and set necessary configurations.\n- Do not forget to check your environment settings in `.env`\n\nFirst, compile typescript codes into javascript by:\n\n```bash\npnpm build\n```\n\nThis will create a `dist` folder and put all compiled `.js` files in there. You can change and set your own configurations by modifying `tsconfig.json` file.\n\nFinally, you can start the project by:\n\n```bash\npnpm start\n```\n\nYou can also use `nodemon` for development:\n\n```bash\npnpm dev\n```\n\n#### Note1:\n\nFor security reasons, you should put \"sslCert\" folder into `.gitignore` file in production mode.\n\n#### Note2:\n\nIf you want to directly run `server.ts` file, you can do this change in `package.json`:\n\n```\n...\n\"scripts\": {\n  ...\n  \"start\": \"nodemon --watch '*.ts' --exec 'ts-node' src/server.ts\",\n  ...\n}\n```\n\nand then run: `nodemon`\n\n### Test Application\n\nFor test we used Jest for functional testing and unit testing. you can write your own tests in `__test__` folder by creating new `your_entity.test.js` and then just run:\n\n```\nnpm run test\n```\n\n#### Note: After development and test, you should put the following script in `.gitignore` file to prevent pushing tests files in production mode repositories:\n\n```\n# test folder\n__tests__\n```\n\n### Docker and Deployment\n\nYou can simply set your own configs in `docker-compose.yml` file and run:\n\n```\nsudo docker-compose up -d\n```\n\n#### References\n\n[Node.js]: https://nodejs.org/en/download/\n[MongoDB]: https://docs.mongodb.com/manual/installation\n[Redis]: https://redis.io/download\n[nodemon]: https://www.npmjs.com/package/nodemon\n[typescript]: https://www.npmjs.com/package/typescript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famin-abbasi%2Ftypescript-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famin-abbasi%2Ftypescript-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famin-abbasi%2Ftypescript-boilerplate/lists"}