{"id":18001973,"url":"https://github.com/xeoneux/typemonpress","last_synced_at":"2025-06-25T08:38:46.705Z","repository":{"id":100958479,"uuid":"89569351","full_name":"xeoneux/TypeMonPress","owner":"xeoneux","description":"🏅 A Boilerplate Starter Application For Building RESTful APIs Microservice in Node.js using Express and Mongoose in TypeScript","archived":false,"fork":false,"pushed_at":"2023-01-12T08:42:27.000Z","size":301,"stargazers_count":15,"open_issues_count":3,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T04:51:21.381Z","etag":null,"topics":["api","boilerplate","express","mongodb","mongoose","rest","starter","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xeoneux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2017-04-27T07:34:47.000Z","updated_at":"2024-08-10T07:23:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"29ec4535-5733-429f-bb07-1bf498b19942","html_url":"https://github.com/xeoneux/TypeMonPress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/xeoneux/TypeMonPress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xeoneux%2FTypeMonPress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xeoneux%2FTypeMonPress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xeoneux%2FTypeMonPress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xeoneux%2FTypeMonPress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xeoneux","download_url":"https://codeload.github.com/xeoneux/TypeMonPress/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xeoneux%2FTypeMonPress/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261837558,"owners_count":23217451,"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":["api","boilerplate","express","mongodb","mongoose","rest","starter","typescript"],"created_at":"2024-10-29T23:19:33.796Z","updated_at":"2025-06-25T08:38:46.682Z","avatar_url":"https://github.com/xeoneux.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeMonPress\n\n## Overview\n\nA Boilerplate Starter Application For Building RESTful APIs Microservice in Node.js using Express and Mongoose in TypeScript. Helps you stay productive by following best practices and standards.\n\n## Getting Started\n\nClone the repo:\n```sh\ngit clone git@github.com:xeoneux/TypeMonPress.git\ncd TypeMonPress\n```\n\nInstall dependencies:\n```sh\nnpm install\n```\n\nSet environment (vars):\n```sh\ncp .env.example .env\n```\n\nStart server:\n```sh\n# Start server\nnpm start\n\n# Start debug server\nnpm run debug\n```\n\nDeployment:\n\n```sh\n# Compile to JS\n1. npm run build\n\n# Upload dist/ to your server\n2. scp -rp dist/ user@dest:/path\n\n# Install production dependencies only\n3. npm install --production\n\n# Use any process manager to start your services\n4. pm2 start dist/index.js\n```\n\nIn production you need to make sure your server is always up so you should ideally use any of the process manager recommended [here](http://expressjs.com/en/advanced/pm.html).\n\nWe recommend [PM2](http://pm2.keymetrics.io/) as it has several useful features like it can be configured to auto-start your services if system is rebooted.\n\n## Logging\n\nUniversal logging library [winston](https://www.npmjs.com/package/winston) is used for logging. It has support for multiple transports.  A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console for simplicity, you can configure more transports as per your requirement.\n\n## Contributing\n\nContributions, questions and comments are all welcome and encouraged. For code contributions submit a pull request with unit test.\n\n## License\nThis project is licensed under the [MIT License](https://github.com/xeoneux/TypeMonPress/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxeoneux%2Ftypemonpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxeoneux%2Ftypemonpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxeoneux%2Ftypemonpress/lists"}