{"id":15715298,"url":"https://github.com/crazyoptimist/service-template-nodejs","last_synced_at":"2025-03-30T20:18:05.023Z","repository":{"id":164355635,"uuid":"639796509","full_name":"crazyoptimist/service-template-nodejs","owner":"crazyoptimist","description":"NodeJS Typescript Service Template","archived":false,"fork":false,"pushed_at":"2023-08-31T07:18:23.000Z","size":224,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T23:00:50.900Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/crazyoptimist.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}},"created_at":"2023-05-12T08:45:57.000Z","updated_at":"2023-06-27T16:30:13.000Z","dependencies_parsed_at":"2024-03-22T08:54:31.810Z","dependency_job_id":null,"html_url":"https://github.com/crazyoptimist/service-template-nodejs","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fservice-template-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fservice-template-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fservice-template-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fservice-template-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazyoptimist","download_url":"https://codeload.github.com/crazyoptimist/service-template-nodejs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246372743,"owners_count":20766635,"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":[],"created_at":"2024-10-03T21:40:52.552Z","updated_at":"2025-03-30T20:18:04.991Z","avatar_url":"https://github.com/crazyoptimist.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NodeJS Typescript Service Template\n\n## Style Guide\n\n### Project Structure\n\n- `src/main.ts` is the starting point of the application, keep it short and simple.\n- `src/helpers` is where we organize broken-down modules that runs business logics, create sub folders if needed.\n- `src/config` is where we organize application global configurations and constants. Every environment variables should be verified(and maybe re-organized as nested objects if we prefer) in src/config. We should not read env vars directly like process.env.FOO, because it's hard to track what's used where.\n- `src/utils` is where we organize utility functions that doesn't contain any business logics\n- `src/common` is where we organize shared code which is reused and is shared between different modules, and is specific to this project. Create sub folders if needed.\n- `src/scripts` is where we organize one-off scripts.\n- `testdata` is where test sample data live. Create sub folders as needed.\n\n### Naming Conventions\n\n- Use `kebab-case` for folders\n- Use `camelCase` for variables, functions, and files\n- Use `PascalCase` for classes, types, interfaces, enums\n- Use `ALL_UPPER_CASE` for constants\n\n### Tests\n\n- Place test files in the same folder as the code that the tests are written for.\n\n## Development\n\n- Node.js(\u003e v18.x) is required\n- Install dependencies\n\n```bash\nnpm i\n```\n\n- Run the application\n\n```bash\nnpm run dev\n```\n\n## Logging\n\n- Structured logging with `pino`\n\n## Documentation\n\n- Organize design documentations into `docs` folder\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyoptimist%2Fservice-template-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazyoptimist%2Fservice-template-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyoptimist%2Fservice-template-nodejs/lists"}