https://github.com/draym/node-api-template
structured API empty template
https://github.com/draym/node-api-template
express-js nodejs rest-api template
Last synced: about 1 month ago
JSON representation
structured API empty template
- Host: GitHub
- URL: https://github.com/draym/node-api-template
- Owner: Draym
- Created: 2023-02-01T04:46:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-02T11:09:07.000Z (about 3 years ago)
- Last Synced: 2025-02-02T19:46:33.775Z (over 1 year ago)
- Topics: express-js, nodejs, rest-api, template
- Language: TypeScript
- Homepage:
- Size: 662 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `API Template` 
## Project Setup
### Prerequisite
1) Create .env file based on .env.example with your own values
2) MySQL database
- start a local MySql server
- Wamp (Windows)
- Mamp (Mac)
- create a new database named the same as the env file
### Start Application
- Build application
```bash
npm run build
```
- Run in local
```bash
npm run dev
```
- Run in production
```bash
npm run build
npm run start
```
- with Docker
```bash
docker build .
```
### API Documentation
API documentation can be viewed on
Link:
## Branch Workflow
### Gitflow
- Standard branch iterative process：`{jira_number}/{branch_name}` -> `dev` & developer test -> `staging` & QA test -> `main`
- Fixing high-priority bugs：`hotfix/{jira_task_number}>{branch_name}` -> `staging` & QA test -> `main`
> `` should be replaced with a short description of the changes on your branch.
### Branches
- `main`：Host the latest stable code. Deployment to production should be triggered by creating a new GitHub TAG.
- `staging`: Test environment branch in order to test Release branch by QA.
- `dev`: Dev environment branch in order to test Release branch by Developers.
- `{jira_number}/{branch_name}`： Release branch. Responsible for development destined to a specific release.
- `{jira_number}/{jira_task_number}_{sub_branch_name}`： SubRelease branch. Responsible for split heavy workload for multiple developers within a Release branch.
- `hotfix/{jira_task_number}_{branch_name}`: HotFix branch. Responsible for fixing issues from Main branch.
This project follows these [documented guidelines](https://github.com/Draym/git-guidelines)