Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node4good/formage
Bootstraped Admin GUI addon for mongoose, jugglingdb, or just as a form generator
https://github.com/node4good/formage
Last synced: about 7 hours ago
JSON representation
Bootstraped Admin GUI addon for mongoose, jugglingdb, or just as a form generator
- Host: GitHub
- URL: https://github.com/node4good/formage
- Owner: node4good
- License: mit
- Created: 2013-01-15T13:15:42.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T12:10:57.000Z (about 1 year ago)
- Last Synced: 2024-09-23T18:01:55.732Z (1 day ago)
- Language: JavaScript
- Homepage: formage.io
- Size: 6.17 MB
- Stars: 185
- Watchers: 16
- Forks: 55
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Formage
[Bootstraped](http://twitter.github.com/bootstrap/) Admin GUI addon for [Mongoose](http://mongoosejs.com/), [JugglingDB](https://github.com/1602/jugglingdb), or just as a form generator.
Originally forked from [mongoose-admin](https://github.com/marccampbell/mongoose-admin).
[](https://travis-ci.org/node4good/formage)
[](https://nodei.co/npm/formage/)
## Example Usage
```js
var express = require('express'),
app = express();
require('formage').init(app, express, models);
```
Look at the `\example` directory.
### Options
```js
// Site-wide options, and their default values
require('formage').init(app, express, models, {
title: 'Admin',
root: '/admin',
default_section: 'main',
username: 'admin',
password: 'admin',
admin_users_gui: true
});
```
#### Model options
```js
var model = new mongoose.model('songs', schema);
// external files specific to this model
model.header_lines = [
'',
''
];
model.formage = {
// one-document models
is_single: true,
// labels
label: 'My Songs',
singular: 'Song',
filters: ['artist', 'year'],
// additional actions on this model
actions: [
{
id: 'release',
label: 'Release',
func: function (user, ids, callback) {
console.log('You just released songs ' + ids);
callback();
}
}
],
// list of fields to be displayed by formage for this model
list: ['number', 'title', 'album', 'artist', 'year'],
// order documents, save order in this field (type: Number)
sortable: 'order',
// list of order fields
order_by: ['-year', 'album', 'number'],
// list of fields that must be populated
// (see http://mongoosejs.com/docs/api.html#document_Document-populate)
list_populate: ['album'],
// list of fields on which full-text search is available
search: ['title', 'album', 'artist']
};
```
#### Fields
Formage comes with the following built-in fields,
but [custom fields](https://github.com/Empeeric/formage/wiki/Custom-Fields) can be written if needed.
- String
- Boolean
- Number
- Date
- Time
- Enum ([select2](http://ivaynberg.github.io/select2/))
- Ref ([select2](http://ivaynberg.github.io/select2/))
- Text (``)
- HTML ([ckeditor](http://ckeditor.com/))
- FilePicker ([File Picker](https://www.inkfilepicker.com/))
- Picture ([File Picker](https://www.inkfilepicker.com/))
- GeoPoint ([Google Maps](https://maps.google.com/))
You can pass options to the underlying fields and widgets:
```js
var schema = new mongoose.Schema({
artist: { type: String, label: 'Who made it?' },
location: { type: Schema.Types.GeoPoint, widget_options: { lang: 'nl' }}
});
```
(The map widget lang setting is a two-letter [ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code.)
#### Hmm
- [Extend formage with your custom field](https://github.com/Empeeric/formage/wiki/Custom-Fields)
- [Embed a formage form outside of the admin](https://github.com/Empeeric/formage/wiki/Outing-Formage-Form)
License
-------
MIT
Sponsor
--------
