/sails-hook-adminpanel

Admin panel generator for Sails.js applications v0.11+

Primary LanguageHTMLMIT LicenseMIT

sails-hook-adminpanel

Join the chat at https://gitter.im/konstantinzolotarev/sails-hook-adminpanel

Admin panel generator for Sails.js applications v0.11+

This hook is under active development. Please be careful lot of functionality will be added. And some configs could change from version to version

Installation

To install this hook you will need to run:

npm install --save sails-hook-adminpanel

Then you will need to create a config file for admin panel generator into config/adminpanel.js

This is example of this file:

'use strict';

module.exports.adminpanel = {
    instances: {

        users: {

            title: 'Users',
            model: 'User',

            list: {
                fields: {
                    id: 'ID',
                    email: 'Email',
                    active: 'Active',
                    admin: 'Admin',
                    createdAt: 'Created'
                }
            },

            edit: {
                fields: {
                    email: 'Email',

                    active: {
                        title: 'Active'
                    },
                    admin: {
                        title: 'Admin',
                        disabled: true
                    }
                }
            }
        }
    }
};

And your admin panel will be accesible under: http://yoururl.com/admin/users

Documentation

Take a look into docs folder. There are lot of docs about configuration and usage.

What is this?

This repo contains a hook, one of the building blocks Sails is made out of.

What version of Sails is this for?

The versioning of a hook closely mirrors that of the Sails version it depends on. While the "patch" version (i.e. the "Z" in "X.Y.Z") will normally differ from that of Sails core, the "minor" version number (i.e. the "Y" in "X.Y.Z") of this hook is also the minor version of Sails for which it is designed. For instance, if a hook is version 0.11.9, it is designed for Sails ^0.11.0 (that means it'll work from 0.11.0 all the way up until 0.12.0).

Does this hook use only Jade for template engine ?

Yes. For now only Jade.

Are there changes?

Yes, see the v0.11 migration guide. You probably won't need to change anything unless you were extensively using the old Socket.io v0.9 configuration.

License

MIT