maa

maap

Maap is a Node.js module for generating administration style interfaces

Showing:

Popularity

Downloads/wk

2

GitHub Stars

9

Maintenance

Last Commit

7yrs ago

Contributors

3

Package

Dependencies

12

Size (min+gzip)

0.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

MaaP - MongoDB as an Admin Platform

MaaP it's an admin platform for generating administration style interfaces, based on Node.js and MongoDB stack.
Its purpose is to make it simple for developers to implement interfaces for manage business data with ease, providing a DSL that allows you to define the content of your webpages in minutes.

Usage

MaaP is an npm package. Setting up MaaP new Project:

npm install -g maap
maap create project
cd project
npm install
vim config.js
npm start

For more details see First usage from wiki.

Configuration Files

You can edit these configuration files:

config.js                    # Back-end configuration
app/scripts/config.js        # Front-end configuration
collections/*.dsl            # DSL configuration File 

For more information see New Project configuration from wiki.

Populate test database

For populate the database with test collections, move to ./extra/ directory. JSON files contain test data.

populate-users-db.sh and populate-data-db.sh are scripts that populate the database with example data, To use them on a local database, do:

./populate-users-db.sh --host localhost:27017 --db users ./populate-data-db.sh --host localhost:27017 --db data

For more details see First usage from wiki.

DSL Configuration

Here are a few common configurations for a DSL file:

collection(
    name: "userscollection", 
    label: "Users", 
    id: "myId", 
    weight: 1 
) {
    index( 
        perpage: 50, 
        populate: "father", 
        sortby: "username", 
        order: "asc", 
        query: { country: "Italy"}
    ) {
        column(
            name: "username", 
            label: "Username", 
            sortable: true, 
            selectable: true, 
            transformation: function(val) { return "The Great " + val; }
        )
        // ...
    }
    show(
        populate: "father"
    ) {
        row(
            name: "username", 
            label: "Username", 
            transformation: function(val) { return "The Great " + val; }
        )
        // ...
    }
} 

For see more details DSL File Configuration and DSL Configuration File Example from wiki.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial