Skip to content

apocist/uniformity

Repository files navigation

uniformity npm Build Status Join the chat at https://gitter.im/apocist/uniformity

A simple but highly customizable NodeJS CMS. Still in alpha development, but provides modular plug and play capabilities to offer only the features you're looking for in a website.

Cannot be used in a production environment at this time.

Install

Install from npm using:

$ npm install uniformity

You will need an Authentication Plugin to perform any changes. The only one available at this time can be installed via

$ npm run plugin 'uniformity-auth-twitter'

Configure your correct Twitter API settings in ./config/config.json (refer to ./config/defaults.json at uniformity-auth-twitter)

NOTE: Any minor version updates may require a npm install to acquire the latest libraries. During Alpha stages, updates will not be considered backwards-compatible.

Plugins

Install any other needed plugins stored in the npm repository. Example:

$ npm run plugin 'uniformity-blog'

Dependencies

#####Needed to install separately

Usage

NOTE: A Mongo Database is required before starting the uniformity service.

$ npm start

The service will then state it is running on the port configured in ./config/config.json.

Notes

It has been known that on Windows platforms, it may be necessary to install node-gyp globally with:

$ npm install -g node-gyp