very-express/dist/templates/root/README.md

based on json schema and openapi, generate Express RestApi server with mongoDb

# This app is generated by [VeryExpress](https://github.com/Justin26l/VeryExpress)

 
# Quick Start
1. install `very-express` from npm  
    `npm install -g very-express` or `npm update -g very-express`  

2. check configuration file [vex.config.json](./vex.config.json) under project root directory and keep it updated (re-generate the app with very-express).  
    `vex`  

3. we should have a express typescript app.  
    ```
    ├── src/ 
    │   └── openapi
    │   └── roles (role based access control settings)
    │   └── system (very express generated app)
    ├── package.json  
    ├── tsconfig.json  
    ├── vex.config.json  
    ├── .env  
    └── ... 
    ```  

4. start the generated express app.  
    ```
    npm i  
    npm build    
    npm run start
    ```

5. start the app in docker.  
    ```
    npm run docker-build  
    npm run docker-start
    ```

# Resource
- [Documents](https://github.com/Justin26l/VeryExpress/blob/main/README.md)
- [VeryExpress Discord](https://discord.gg/PZGMzDp7)