nodisan
v1.5.13-dev
Published
Nodisan is a boilerplate generator inspired in **artisan** from **laravel**. This module for nodejs works similar to that and that makes it possible to enjoy all the benefits that this entails.
Downloads
90
Readme
Nodisan
Nodisan is a boilerplate generator inspired in artisan from laravel. This module for nodejs works similar to that and that makes it possible to enjoy all the benefits that this entails.
Requirements
| Nodejs | Npm | |--|--| | | |
Instalation
To start a backend project with nodisan, you only have to start a new project in any folder you want and run
mkdir first-nodisan-project
cd first-nodisan-project
Then run:
npm init -y
npm i nodisan@latest
Now you will notice that the common process of installing any Nodejs package will be executed, but with the difference that a file will appear in your root folder: nodisan.js.
This file is the entry point of the application and it is the one that will generate the templates.
To start the process of creating them, you only have to do:
node nodisan
And, in principle, that is all.
Commands
With Nodisan, you can run commands as if you were working with Artisan in Laravel. The difference lies in how you can call these commands. In Laravel, a command like this:
php artisan make:controller controllerName
In Nodisan, it can be used like this:
node nodisan make:controller controllerName
You can see a full list of valid commands by typing:
node nodisan -h
or node nodisan --help
Functions
resource()
This method gives you the possibility to skip the get, post, put, and delete configuration, making it automatic if you started your controller with the --resource
tag.
You must add the import at the top of your route file:
import { resource } from 'nodisan/src/resource.js'
Also, add the additional imports and their respective assignments:
import express from 'express'
import * as crudMethods from '../controllers/controllerName'
const router = express.Router()
Now you can run:
resource(router, crudMethods, middleware)
In development
- Integration of tipical commands of artisan, considering the differences between php and js, commands like: