https://github.com/njkleiner/controller-base

A (CRUD) controller template for MVC in Express.
https://github.com/njkleiner/controller-base

crud express mvc nodejs

Last synced: 4 days ago
JSON representation

A (CRUD) controller template for MVC in Express.

• Host: GitHub
• URL: https://github.com/njkleiner/controller-base
• Owner: njkleiner
• License: mit
• Created: 2019-04-23T05:57:07.000Z (almost 6 years ago)
• Default Branch: develop
• Last Pushed: 2019-10-05T09:46:20.000Z (over 5 years ago)
• Last Synced: 2024-05-20T23:26:55.188Z (8 months ago)
• Topics: crud, express, mvc, nodejs
• Language: JavaScript
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# controller-base

> A (CRUD) controller template for MVC in Express.

## Getting Started

### Installing

`$ npm install controller-base`

### Usage

The controller follows the [Ruby on Rails methodology](https://www.codecademy.com/articles/standard-controller-actions).

All action methods are asynchronous so that you can easily use the `async`/`await` syntax when implementing them. They are wrapped using a higher-order function that passes errors to the next handler in the chain.

Each method has the following signature: `async $action(request, response, next)`, the controller will register the following action methods by default:

* `$index`

* `$new`

* `$create`

* `$show`

* `$edit`

* `$update`

* `$destroy`

Simply extend the controller class and override the `$action` methods and add your own actions as needed.

```javascript

// controllers/account.js

const Controller = require('controller-base');

class AccountsController extends Controller {

    async $index(request, response, next) {

        // List all accounts...

    }

    

    // Implement the other $action methods as needed.

    

    // Add a custom $action

    // NOTE: Unlike the default methods, this one is not declared using the `async` keyword.

    $action(request, response, next) {

        response.send('/action');

    }

    

    // Override the configure method to register your custom action.

    configure(router) {

        // Call the super method to configure the default actions.

        super.configure(router);

        

        // And configure your custom action.

        const self = this;

        router.get('/action', (request, response, next) => self.$action(request, response, next));

    }

}

module.exports = new AccountsController();

```

Then call the `configure` method on your controller instance and pass it a [Router](https://expressjs.com/en/4x/api.html#router) object.

```javascript

const AccountsController = require('./controllers/account');

const router = new express.Router();

AccountsController.configure(router);

// ...

app.use('/accounts', router);

```

## Contributing

This project uses the git branching model [described here](https://nvie.com/posts/a-successful-git-branching-model/).

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/njkleiner/controller-base/tags). 

## Authors

* [Noah Kleiner](https://github.com/njkleiner)

See also the list of [contributors](https://github.com/njkleiner/controller-base/contributors) who participated in this project.

## License

This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

* This project is inspired by [Ruby on Rails](https://rubyonrails.org/).

* [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) by [Billie Thompson](https://github.com/PurpleBooth).