# cakeServer **Repository Path**: carin123/cake-server ## Basic Information - **Project Name**: cakeServer - **Description**: No description available - **Primary Language**: NodeJS - **License**: Not specified - **Default Branch**: develop - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-09-12 - **Last Updated**: 2024-10-23 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Cake Server ## Overview This project, built with - [Koa](https://koa.bootcss.com/) - [mysql](https://www.mysql.com/cn/) ## Setup Development Environment ### Prerequisites Ensure you have [Node.js](https://nodejs.org/) installed (v18.16.0 recommended). ### Install Dependencies ```sh npm install ``` ### Run Development Server ```sh npm run dev ``` Access the development environment at http://localhost:3071. ### Branch Management - main: Production stable branch, accepts PRs only from the develop branch. - develop: Main development branch for day-to-day work. - feature/\*: Feature development branches for individual features. ### Commit Guidelines Each commit message consists of a **header** and a **body**. The header has a special format that includes a **type** and a **subject**: ``` : ``` example: ```markdown chore: support NodeJS LTS v14. fix audit issues - from:483 vulnerabilities found - 273 Low | 38 Moderate | 168 High | 4 Critical - to: 389 vulnerabilities found - 259 Low | 28 Moderate | 98 High | 4 Critical ``` The **header** is mandatory. Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. #### Type Must be one of the following: - **feat**: A new feature - **fix**: A bug fix - **docs**: Documentation only changes - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) - **refactor**: A code change that neither fixes a bug nor adds a feature - **perf**: A code change that improves performance - **test**: Adding missing or correcting existing tests - **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation - **revert**: code revert - **build**: code build #### Subject The subject contains succinct description of the change: - use the imperative, present tense: "change" not "changed" nor "changes" - don't capitalize first letter - no dot (.) at the end #### Body Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. #### Revert If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit .`, where the hash is the SHA of the commit being reverted.