https://github.com/updata7/node-mysql-koa2
一个使用Node.js➕MySQL➕Koa2编写的轻量级Web后端框架
https://github.com/updata7/node-mysql-koa2
joi koa2 mysql node sequelize swagger-ui
Last synced: 6 months ago
JSON representation
一个使用Node.js➕MySQL➕Koa2编写的轻量级Web后端框架
- Host: GitHub
- URL: https://github.com/updata7/node-mysql-koa2
- Owner: updata7
- License: mit
- Created: 2023-01-06T05:56:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T15:33:16.000Z (almost 3 years ago)
- Last Synced: 2025-03-25T21:21:34.475Z (7 months ago)
- Topics: joi, koa2, mysql, node, sequelize, swagger-ui
- Language: TypeScript
- Homepage:
- Size: 26.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-EN.md
- License: LICENSE
Awesome Lists containing this project
README
# node-mysql-koa2
## introduction
- This project uses Node.js ➕ MySQL ➕ Koa2，it is a Lightweight Web back-end framework
- **MySQL** uses [Sequelize](https://github.com/sequelize/sequelize)
- Api documents are generated automatically using **swagger**
- Using **MVC** mode, it is simple to package, easy to expand, and can be learned by novices or quickly used for secondary development
- The demos currently implemented include creating users and obtaining user lists.
## run result
## API Docs（Auto generate）
# prepare
To builde and run the project, you will need a few thing:
- Install [Node.js 16.15.1+](https://nodejs.org/en/)
- Install [mysql server v8.0.19+](https://www.mysql.com/)
# Getting started
- Clone the repository
```bash
git clone --depth=1 https://github.com/updata7/node-mysql-koa2.git
```
- Install dependencies
```bash
cd node-mysql-koa2
npm install
```
- Build the project
```bash
npm run build
```
- Run the project
```bash
npm run dev
```
- Unit Test
**test**
```bash
npm run test
```
**Generate test coverage report**
```bash
npm run cover
```
- Test the API
Navigate to `http://localhost:9091/api/docs`, you would **see** and **test** the API!!!
## The full folder structure of this proejct is explained below:
> **Note!** Make sure you have already built the proejct and using `npm run dev`
| Name | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **src/config** | Contains config environment to be used by the config package, such as MongoDB URI, jwtSecret, and etc. |
| **dist** | Contains the distributable (or output) from your TypeScript build |
| **node_modules** | Contains all your npm dependencies |
| **src** | Contains your source code that will be compiled to the dist dir |
| **src/middlewares** | Contains the middlewares to intercept requests |
| **src/models** | Model define Mysql schemas that will be used in storing and retrieving data from Mysql |
| **src/engines** | This module will directly operate the database through the model |
| **src/handlers** | This field will be used in router and call the **engines** |
| **src/routers** | The router for client call |
| **src/swaggers** | Swagger UI for API |
| **src/utils** | Some common internal interfaces |
| **src/bin/server.ts** | Entry point to your Koa project |
| **src/app.ts** | The helper file be used by server.ts |
| package.json | File that contains npm dependencies as well as [build scripts](#what-if-a-library-isnt-on-definitelytyped) |
| tsconfig.json | Config settings for compiling server code written in TypeScript |
## License
MIT
If it is helpful to you, please click a star to encourage me, or if you have better suggestions and opinions,
please come forward and let me know and leave a message. I hope it can help you learn!
Thanks!Let's encourage each other!