{"id":15508663,"url":"https://github.com/draym/node-api-template","last_synced_at":"2026-05-06T04:07:39.068Z","repository":{"id":98461890,"uuid":"595924789","full_name":"Draym/node-api-template","owner":"Draym","description":"structured API empty template","archived":false,"fork":false,"pushed_at":"2023-05-02T11:09:07.000Z","size":678,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T19:46:33.775Z","etag":null,"topics":["express-js","nodejs","rest-api","template"],"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/Draym.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-02-01T04:46:42.000Z","updated_at":"2023-09-13T22:08:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"f28e6d83-cf31-4e90-9ab6-fff0e6a5e96c","html_url":"https://github.com/Draym/node-api-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Draym%2Fnode-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Draym%2Fnode-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Draym%2Fnode-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Draym%2Fnode-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Draym","download_url":"https://codeload.github.com/Draym/node-api-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246083288,"owners_count":20720939,"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":["express-js","nodejs","rest-api","template"],"created_at":"2024-10-02T09:39:35.477Z","updated_at":"2026-05-06T04:07:39.056Z","avatar_url":"https://github.com/Draym.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `API Template` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge\u0026logo=node.js\u0026logoColor=white)![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n\n## Project Setup\n\n### Prerequisite\n1) Create .env file based on .env.example with your own values\n2) MySQL database\n    - start a local MySql server\n        - Wamp (Windows)\n        - Mamp (Mac)\n    - create a new database named the same as the env file\n\n### Start Application\n- Build application\n```bash\nnpm run build\n```\n- Run in local\n```bash\nnpm run dev\n```\n- Run in production\n```bash\nnpm run build\nnpm run start\n```\n\n- with Docker\n```bash\ndocker build .\n```\n\n### API Documentation\nAPI documentation can be viewed on\nLink:\n\n\n## Branch Workflow\n\n### Gitflow\n\n- Standard branch iterative process：`{jira_number}/{branch_name}` -\u003e `dev` \u0026 developer test -\u003e `staging` \u0026 QA test -\u003e `main`\n- Fixing high-priority bugs：`hotfix/{jira_task_number}\u003e{branch_name}` -\u003e `staging` \u0026 QA test -\u003e `main`\n\n\u003e `\u003cBRANCH_NAME\u003e` should be replaced with a short description of the changes on your branch.\n\n### Branches\n- `main`：Host the latest stable code. Deployment to production should be triggered by creating a new GitHub TAG.\n- `staging`: Test environment branch in order to test Release branch by QA.\n- `dev`: Dev environment branch in order to test Release branch by Developers.\n- `{jira_number}/{branch_name}`： Release branch. Responsible for development destined to a specific release.\n- `{jira_number}/{jira_task_number}_{sub_branch_name}`： SubRelease branch. Responsible for split heavy workload for multiple developers within a Release branch.\n- `hotfix/{jira_task_number}_{branch_name}`: HotFix branch. Responsible for fixing issues from Main branch.\n\nThis project follows these [documented guidelines](https://github.com/Draym/git-guidelines)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdraym%2Fnode-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdraym%2Fnode-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdraym%2Fnode-api-template/lists"}