ngduc/node-rem

Node REM - NodeJS Rest Express MongoDB and more: typescript, passport, JWT, socket.io, HTTPS, HTTP2, async/await, nodemailer, templates, pagination, docker, etc. Live Demo: https://node-rem-ngduc.vercel.app

Node REM

NodeJS Rest Express MongoDB (REM) - a production-ready lightweight backend setup.

Live Demo (login with a test user: [email protected], user111 - inspect API calls to learn more)

🌟 It rains cats and dogs features:

  Typescript      Express   CORS     Helmet    DotEnv   joi (validation)   forever
  Mongoose        Passport  JWT      Await
  Tslint          Apidoc    Docker   Husky    Morgan    Travis   Unix/Mac/Win (Powershell)
  Tests
            Mocha  Chai     Sinon    istanbul
  MORE:
            HTTPS           HTTP2 (spdy)      Socketio 2.1       Init DB Data
            Slack message   Nodemailer        Mailgun            Email Templates    Forgot Password
            VSCode Debug    Dependabot        Codacy             File upload (multer)
      API
            API response    (data, meta: limit, offset, sort)    Transform res
            apiJson         Pagination query
            Regex query     Whitelist fields in response         Populate deep fields
            mstime          API response time     Stack trace in Response
      UI Example
            CRA, Typescript, React-router, Axios, PostCSS, Tailwind. Components: Login, Home, ItemView.
            Portable-react

• More details in Documentation / Features

📦 Installation

Require: MongoDB and NodeJS v8.12.0 +

Clone this project:

git clone https://github.com/ngduc/node-rem.git your-app
cd your-app
rm -rf .git   (remove this github repo's git settings)
yarn

• Update package.json and .env file with your information.
• Run yarn dev, it will create a new Mongo DB "node-rem"
• Verify yarn test can run all unit tests.
• Verify: use Postman to POST http://localhost:3009/api/v1/auth/register to create a new user. (set payload to have email, password)

curl -k -d '{"email": "[email protected]", "password": "testpsw"}' -H "Content-Type: application/json" -X POST http://localhost:3009/api/v1/auth/register

🔧 Commands

- Start MongoDB first. Verify .env variables.

yarn dev      launch DEV mode
yarn start    launch PROD mode
yarn stop

yarn test     Run tests   (requires MongoDB)

Frontend Example - uses this node-rem backend:

- First, start the Backend with: yarn dev

- Then, start UI:
cd ./ui
yarn
yarn start    (then open http://localhost:3000 - login with a test user: [email protected], user111)

📖 Features

Your simple API Route Handler will have a nice syntax like this: (packed with vitamins cool stuffs)

exports.list = async (req: Request, res: Response, next: NextFunction) => {
  try {
    const data = (await User.list(req)).transform(req); // query & run userSchema.transform() for response
    apiJson({ req, res, data, model: User }); // return standard API Response
  } catch (e) {
    next(e);
  }
};

API Response is similar to JSON API standard:

GET http://localhost:3009/api/v1/users?fields=id,email&email=*user1* (get id & email only in response)
GET http://localhost:3009/api/v1/users?page=1&perPage=20 (query & pagination)
GET http://localhost:3009/api/v1/users?limit=5&offset=0&sort=email:desc,createdAt
{
    "meta": {
        "limit": 5,
        "offset": 0,
        "sort": {
            "email": -1,
            "createdAt": 1
        },
        "totalCount": 4,
        "timer": 3.85,
        "timerAvg": 5.62
    },
    "data": [
        {
            "id": "5bad07cdc099dfbe49ef69d7",
            "name": "John Doe",
            "email": "[email protected]",
            "role": "user",
            "createdAt": "2018-09-27T16:39:41.498Z"
        },
        // more items...
    ]
}

Example of generated API Docs (using apidoc) - https://node-rem.netlify.com

📖 Documentation

• Documentation / Features
• Build System
• Dependencies Notes
• Change Log

🙌 Thanks

All contributions are welcome!

UI Example uses Portable-react

node-rem's Issues

"docker:start"

how can this command work? it is in dockerfile

environment yml indentation

Build steps currently fail early do to incorrect indentation of environment:

docker-compose.dev.yml
docker-compose.prod.yml

version: "2"
services:
  boilerplate-api:
    command: yarn dev -- -L
  environment:
    - NODE_ENV=development

should be

version: "2"
services:
  boilerplate-api:
    command: yarn dev -- -L
    environment:
      - NODE_ENV=development

Error on dev

Great looking project! Seem to get an error on dev however

yarn docker:dev

output...

[5/5] Building fresh packages...
$ cd ./node_modules && node ../package_symlinks.js && cd ..
module.js:550
    throw err;
    ^

Error: Cannot find module '/app/package_symlinks.js'
    at Function.Module._resolveFilename (module.js:548:15)
    at Function.Module._load (module.js:475:25)
    at Function.Module.runMain (module.js:694:10)
    at startup (bootstrap_node.js:204:16)
    at bootstrap_node.js:625:3
error Command failed with exit code 1.

Custom Validation Messages

Title

• enhancement: Is it possible to use following package for custom validation messages?
  https://github.com/sivabalan02/relish_message

If possible how? can you guide where to implement this?

many path Error: Cannot find module '../xxx'

many modules not found

Error: Cannot find module 'xxx'

• Error: Cannot find module '../models/refreshToken.model'
• ... many more like this

Environment Details

• OS: Windows 10
• Node.js version: v8.12.0
• npm version: 6.4.1

Long Description

• I manually updated some, but it seems i need to configure something?

bug: query validation

If the query is:
http://localhost:3009/v1/users?role=admin&limit=5&offset=0&sort=email:desc,createdAt
shouldn't validation be:

listUsers: {
    query: Joi.object({
      page: Joi.number().min(1),
      perPage: Joi.number().min(1).max(100),
      limit: Joi.number().min(1),
      offset: Joi.number().min(1),
      role: Joi.string().valid(...User.roles),
      sort: Joi.string(),
    })
  }

instead of:

listUsers: {
    query: Joi.object({
      page: Joi.number().min(1),
      perPage: Joi.number().min(1).max(100),
      name: Joi.string(),
      email: Joi.string(),
      role: Joi.string().valid(...User.roles)
    })
  }

I might be wrong but the second one doesn't work for me, it gives - validation error

How to find user base on an accessToken using findOne?

Just a question.
I want to find a user based on their access token.
Can you guide me how to do that?

Thanks

bug: ModelUtils method getPopulateArray

If there is only one param provided then method gives queryArray.map is not a function becuase queryArray is not an array but one string

Not run with Node 15

it stuck here.

yarn run v1.22.4
$ npx nodemon --watch 'src/**/*.ts' --ignore 'src/**/*.spec.ts' --exec ts-node --files src/index.ts
[nodemon] 2.0.7
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): src/config/express.ts
[nodemon] watching extensions: ts,json
[nodemon] starting `ts-node src/config/mongoose.ts src/config/passport.ts src/config/vars.ts --files src/index.ts`
[nodemon] clean exit - waiting for changes before restart

switch back to 12 works well

1

2

1

2

add logout method

add logout method

• feature: please add logout route with logout management.!

Short Description:

• Unable to set logout to server

ts-node 8.0.3 breaks just downgrade to 8.0.2

Short Description:

• ts-node 8.0.3 breaks with TypeError: Unable to require .d.ts file

Workaround
downgrade to 8.0.2
...