Skip to content
Make a dazzling node API
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example ♻️ Cleaning the code samples Jun 23, 2018
images 📝 Update README Jun 20, 2018
src 🔒 Stop using .inspect ( deprecated ) Jun 20, 2018
test Add new tests Jun 20, 2018
.eslintrc.json 🚨 Remove unused rules Jun 20, 2018
.gitignore
.npmignore
CODE_OF_CONDUCT.md 👥 Opening to contributions (#5) Jul 27, 2018
CONTRIBUTING.md 👥 Opening to contributions (#5) Jul 27, 2018
LICENSE
README.md
package.json Clean dependencies Jun 27, 2018

README.md

Twitter URL

Lumie Logo

🤔 DESCRIPTION

Lumie is a lightweight module that allows you to set up a scalable controllers architecture for your nodejs project.

Maintainable
Scalable
Quick setup
Easily testable

💾 INSTALLATION

npm install lumie

🔩 HOW IT WORKS

Lumie goes through the files and folders inside your controllers directory to find what we call "routing definitions".
Each controllers are defined in files, which export their routing definitions ( example )

By default, we use the name of the file that exports the routing definition to name the route

/ > controllers > cars.js will create the endpoints /cars/*
/ > controllers > admin > rules.js will create the endpoints /admin/rules/*
/ > controllers > users > users.routing.js will create the endpoints /users/*

⚙️ CONFIGURATION

const express = require("express");
const path = require("path");
const lumie = require("lumie");

const app = express();

lumie.load(app, {
  preURL: "api",
  verbose: true,
  ignore: ["*.spec", "*.action"],
  controllers_path: path.join(__dirname, "controllers")
});

const server = app.listen(3000, "127.0.0.1", () => {
  const { address, port } = server.address();
  console.log("Example app listening at http://%s:%s", address, port);
});

Options

Name type default value Description
verbose boolean false Will print or not the routes name in the console
preURL string null Prefix your route URLs
ignore string[] null Lumie will not try to find a routing definition in those files.
controllers_path string path.join(__dirname, 'controllers') The path of your controllers folder.
routing_files string *.routing How you want to name routing files.
permissions function null A function that takes in parameter a level access and returns an express middleware. This is useful if you want to restrict access for some URLs. With this option enabled, you will be able to set in each route configuration an option level that will be passed to your permission function ( example )

🌲FILE STRUCTURE

project/
├── controllers/
│   ├── user/
│   │   ├── user.routing.js
│   │   ├── user.action.js
│   │   └── user.spec.js
│   ├── car/
│   │   ├── car.routing.js
│   │   ├── car.spec.js
|   |   ├── car-get.action.js
│   │   └── car-post.action.js
│   └── simple-ctrl.js
├── core/
│   └── permissions.js
├── app.js
└── package.json

alt text

🎮 USAGE

Example: project/controllers/cars.js

const postCars = require("./car-post.action");
const getCars = require("./car-get.action");

module.exports = {
  path: "awesome-cars", // rename the path of the route (optional)
  '/': {
    post: {
      middlewares: postCars.middlewares,
      action: postCars.action,
      level: 'public'
    },
    get: {
      action: getCars.getAll,
      level: 'public'
    }
  },
  '/:id': {
    get: {
      action: getCars.getOne,
      level: 'public'
    }
  }
};
'/<name of your route>': {
        < get | put | delete | post >: {
            action: < function(req, res) >,
            level: < parameters of you permission function >, // Optional
            middlewares: < Array(function(req, res, next)) >// Optional
        }
    }

🌠 BEST PRACTICES

There is 2 common way to create a controller with Lumie, you can take a look here to learn how to implement them.

  • Minimal (sample): You only create one file which takes as name, the name of the controller you want to create. Then you define the routing definition and the functions. This method is recommended if you plan to have a small controller with few actions.
  • Structured (sample): You create a new directory with the name of the controller. Inside, you create:
    • [your-controller-name].routing.js which contains the routing definition
    • [your-controller-name].actions.js which contains the action functions of the controller.
    • [your-controller-name].spec.js This one is optional

If your controller is pretty heavy, with a lot of functions, we recommend to create one file per action (create-user.action.js, get-user.action.js, etc… ) (sample)

🤙 EXAMPLES

🚀 ROADMAP

Here are the next features planned, let me know if you have some ideas

  • Create a CLI to generate new controllers / projects

☕️ SUPPORT

You can support the project by

If you are struggling to setup Lumie, you found a bug or if you have some improvement ideas, feel free to create an issue

Buy Me A Coffee

⚖️ LICENSE

This software is licensed under the MIT © Alex Levacher

You can’t perform that action at this time.