Skip to content

Justin26l/VeryExpress

Repository files navigation

VeryExpress

this is a generator to make Express app
with custom REST API defined in Json Schema and Open Api

Features

Why use ExpressJs

express.js is a simple & flexible framework to build a web app, it provide balanced performance,
as this is open-source project, i want lower the technical barrier to contribute ideas,
eventually lead to a usefull and powerful framework.

Quick Start

  1. install package globally.
    npm i -g very-express

  2. use cli to initialize configuration file vex.config.json under your project root directory.
    vex -init

  3. create a empty directory and name it as value of vex.config's "jsonSchemaDir", by default jsonSchema.
    mkdir jsonSchema.

  4. you can create your db collection/table now in directory ./jsonSchema just created,
    refer to Define Json Schmea, every changes require to regenerate app.

  5. generate the app with vex.config param.
    vex

  6. you should saw a express typescript app being generated (with src, package.json etc) .

    ├── jsonSchema/  
    │   └── ...
    ├── src/ 
    │   └── ...
    ├── package.json  
    ├── tsconfig.json  
    ├── vex.config.json  
    └── .env  
    
  7. start the generated express app.

    npm i  
    npm build    
    npm run start
    

Resource

Packages

No packages published

Contributors 2

  •  
  •