Helper to quickly create a backoffice for a Vulcan.js application
Switch branches/tags
Nothing to show
Clone or download
Latest commit 8447a6a Oct 11, 2018
Permalink
Failed to load latest commit information.
lib fixed i18n token Oct 11, 2018
test fixed options creation Oct 11, 2018
.eslintrc simplified collection list Sep 14, 2018
.gitignore fixed routes Oct 10, 2018
LICENSE Initial commit Sep 11, 2018
README.md readme Sep 12, 2018
package.js fixed routes Oct 10, 2018
package.json bump version Oct 11, 2018

README.md

Vulcan Backoffice Builder

Setup a backoffice in a matter of minutes

This package provides helpers to quickly create a backoffice for Vulcan.js applications. Given any collection (Users, Posts, Customers etc.), it creates pages that allow to list, visualize, create and edit data.

It relies on Vulcan Material UI package for the frontend. See the Awesome Vulcan demo app core package for an usage example.

/!\ This is an experimental package, API will certainly evolve in the months to come.

Installation

Clone this repo:

git clone https://github.com/lbke/vulcan-backoffice-builder

You can clone it directly in your app packages folder. You can also clone it in an isolated vulcan-packages folder outside of your app, and then set the METEOR_PACKAGE_DIRS environment variable to "/some-dir/vulcan-packages". This way, you can put all your reusable package in this vulcan-packages folder without polluting your own app.

Then use the package in your app:

import { theFunctionYouNeed } from "vulcan:backoffice-builder"

This package won't be published on Atmosphere or npm until it is a bit more mature.

Contributing

This package will evolve and improve depending on the use cases we encounter. Best way to contribute is to use it in your own app, and propose ideas, suggestions and PR based on your experience.

We seek for maximum reusability, so each method should be as configurable as possible, and split into independant functions whenever possible.

Built with love by LBKE