Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 4.22 KB

README.md

File metadata and controls

123 lines (90 loc) · 4.22 KB
Raw

Drywall

A website and user system for Node.js. What you create with Drywall is more important than Drywall. See a bird's eye view.

Dependency Status devDependency Status

Technology

On The Server On The Client Development
Express Bootstrap Grunt
Jade Backbone.js Bower
Mongoose jQuery
Passport Underscore.js
Async Font-Awesome
EmailJS Moment.js

Live Demos

Platform Username Password
https://drywall.herokuapp.com/ root h3r00t
https://drywall.nodejitsu.com/ root j1ts00t
https://drywall.onmodulus.net/ root m0dr00t

Note: The live demos have been modified so you cannot change the root user, the root user's linked Administrator role or the root Admin Group. This was done in order to keep the app ready to test at all times.

Requirements

You need Node.js and MongoDB installed and running.

We use Grunt as our task runner. Get the CLI (command line interface).

$ npm install grunt-cli -g

We use Bower as our front-end package manager. Get the CLI (command line interface).

$ npm install bower -g

We use bcrypt for hashing secrets. If you have issues during installation related to bcrypt then refer to this wiki page.

Installation

$ git clone [email protected]:jedireza/drywall.git && cd ./drywall
$ npm install && bower install
$ mv ./config.example.js ./config.js #set mongodb and email credentials
$ grunt

Setup

You need a few records in the database to start using the user system.

Run these commands on mongo. Obviously you should use your email address.

use drywall;
db.admingroups.insert({ _id: 'root', name: 'Root' });
db.admins.insert({ name: {first: 'Root', last: 'Admin', full: 'Root Admin'}, groups: ['root'] });
var rootAdmin = db.admins.findOne();
db.users.save({ username: 'root', isActive: 'yes', email: '[email protected]', roles: {admin: rootAdmin._id} });
var rootUser = db.users.findOne();
rootAdmin.user = { id: rootUser._id, name: rootUser.username };
db.admins.save(rootAdmin);

Now just use the reset password feature to set a password.

  • http://localhost:3000/login/forgot/
  • Submit your email address and wait a second.
  • Go check your email and get the reset link.
  • http://localhost:3000/login/reset/:email/:token/
  • Set a new password.

Login. Customize. Enjoy.

Philosophy

  • Create a website and user system.
  • Write code in a simple and consistent way.
  • Only create minor utilities or plugins to avoid repetitiveness.
  • Find and use good tools.
  • Use tools in their native/default behavior.

Features

  • Basic front end web pages.
  • Contact page has form to email.
  • Login system with forgot password and reset password.
  • Signup and Login with Facebook, Twitter, GitHub and Google.
  • Optional email verification during signup flow.
  • User system with separate account and admin roles.
  • Admin groups with shared permission settings.
  • Administrator level permissions that override group permissions.
  • Global admin quick search component.

Contributing

Contributions welcome. Make sure your code passes grunt lint without error.

If you're changing something non-trivial or user-facing, you may want to submit an issue first.

License

MIT

githalytics.com alpha