Install Server App

Thank you for choosing modular-rest to build your app. You can install the server app in two ways:

Create a new project

In this way, you can create a new project with modular-rest server app. it will create a new folder with your project name and setup the project for you.

Just use below command:

npm

npm create @modular-rest/server@latest my-project

yarn

yarn create @modular-rest/server my-project

And now you can start your project with below commands:

cd my-project
npm install
npm start

Add modular-rest server client to your project

It assumed that you have initialized a project with npm, then use below command to install modular-rest server client.

npm i @modular-rest/server --save

Now you can use modular-rest server client in your project.

const { createRest } = require('@modular-rest/server');

const app = createRest({
    port: '80',
    mongo: {
        mongoBaseAddress: 'mongodb://localhost:27017',
        dbPrefix: 'mrest_'
    },
    onBeforeInit: (koaApp) => {
       // do something before init with the koa app
    }
})