README old.md

Description

This demo is a demo with users and groups with sub documents, also known as joins in SQL.

Setup

Installation for development

Clone the repository with

git clone https://github.com/theotheu/users-and-groups.git ~/workspaces/users-and-groups

Go to the working directory

cd ~/workspaces/users-and-groups

Configuration

Copy config.js.default to config.js.

cp ~/workspaces/users-and-groups/server/config/config.js.default ~/workspaces/users-and-groups/server/config/config.js

Change the database, port and emailaddress.

vi ~/workspaces/users-and-groups/server/config/config.js

Example

module.exports = {
    development: {
        debug: false, // <--------------------------------- Replace this with your debug preference
        db: 'mongodb://localhost/p496720', // <------------ Replace this with your database name
        port: 3000, // <----------------------------------- Replace this with your port number
        mailTo: "you@example.com",  // <------------------- Replace this with your email address
        AccessControlAllowMethods: "GET,PUT,POST,DELETE",
        allowedDomains: "*"
    }
    , test: {
    }
    , production: {
    }
}

Import data

This is optional and not required but might be convenient. See the separate README in the data directory.

Install node modules

The archive is without the node modules.

Install with

cd ~/workspaces/users-and-groups/server
npm install

Set environment

Set the environment variable for development (default), test or production

export NODE_ENV=development

supervisor

Make sure you have supervisor installed - with the global option

npm install -g supervisor

Use it with

supervisor --no-restart-on error server.js

Instructions to prepare a deployment

• Verify that you have a explanatory README.md
• Make sure that the output directory exist mkdir ~/workspaces/users-and-groups/data
• Make an export of your data with mongodump
• mongodump -d p496720 -o ~/workspaces/users-and-groups/data
• (see http://docs.mongodb.org/v2.2/reference/mongodump/)
• Create in ~/workspaces/users-and-groups/data a README.md with import instructions.
• Push the repository