Merge pull request #95 from nameczz/main

add server readme

server/README.md

@@ -1,73 +1,42 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
-</p>
+# Milvus insight server
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
+Milvus insight server use [nest](https://docs.nestjs.com/)
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+Milvus insight server depend on [milvus2-node-sdk](https://www.npmjs.com/package/@zilliz/milvus2-sdk-node) to operate milvus data.
 
-## Description
+## How to run
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+1. yarn install
+2. yarn start:dev
 
-## Installation
+## Folder Structure
 
-```bash
-$ npm install
-```
+    .
+    ├── auth                    # Jwt authentication not useful for now
+    ├── collections             # Manage milvus collections api
+    ├── interceptors            # Nest interceptors related
+    ├── middlewares             # Nest middlewares related
+    ├── milvus                  # Milvus itself infomation api. Every other api modules need import this module.
+    ├── partitions              # Manage milvus partitions api
+    ├── pipe                    # Nest pipe related
+    ├── schema                  # Manage milvus schema api
+    ├── users                   # Working with auth module, not useful for now.
+    ├── utils                   # Common helping functions.
+    ├── app.xxx.ts              # Need import all other modules to app module.
+    └── main.ts                 # Usually we dont need change this.
 
-## Running the app
+### How to create new module
 
-```bash
-# development
-$ npm run start
+1. nest g module your-module-name
+2. nest g service your-module-name
+3. nest g controller your-module-name
 
-# watch mode
-$ npm run start:dev
+### Api validation
 
-# production mode
-$ npm run start:prod
-```
+We use [class-validator](https://github.com/typestack/class-validator) to help us.
+So normally we have dto.ts for every controller file.
 
-## Test
+### Swagger Doc
 
-```bash
-# unit tests
-$ npm run test
-
-# e2e tests
-$ npm run test:e2e
-
-# test coverage
-$ npm run test:cov
-```
-
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
-
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
-## License
-
-Nest is [MIT licensed](LICENSE).
+We need use ApiProperty to tag every field in dto.ts file and use ApiTags in every controller file.
+After you start server, you can http://localhost:3000/api to see swagger doc.