Trust Roots

"Travellers network"

Trust Roots is developed using MEAN.js boilerplate is based on MongoDB, Node.js, Express, and AngularJS.

Prerequisites

Make sure you have installed all these prerequisites:

• Node.js and the npm package manager, if you encounter any problems, you can also use this Github Gist to install Node.js.
• MongoDB, and make sure it's running on the default port (27017).
• Bower to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm: npm install -g bower
• Grunt task runner to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm: npm install -g grunt-cli

Cloning repository

$ git clone https://github.com/Trustroots/trustroots.git trustroots

This will clone the latest version of the Trust Roots repository to a trustroots folder.

Downloading the repository zip file

$ wget https://github.com/Trustroots/trustroots/archive/master.zip -O trustroots.zip; unzip trustroots.zip; rm trustroots.zip

Quick Install

Install the Node.js dependencies.

Run this inside trustroots folder:

$ npm install

This command does a few things:

• First it will install the dependencies needed for the application to run.
• If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.
• Finally, when the install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application.

Running Your Application

After the install, just run grunt default task:

$ grunt

...that equals to:

$ NODE_ENV=development grunt default

Your application should run on the 3000 port so in your browser just go to http://localhost:3000

Development and deployment With Docker

• Install Docker

• Install Fig

• Local development and testing with fig:

$ fig up

• Local development and testing with just Docker:

$ docker build -t trustroots .
$ docker run -p 27017:27017 -d --name db mongo
$ docker run -p 3000:3000 --link db:db_1 trustroots
$

• To enable live reload forward 35729 port and mount /app and /public as volumes:

$ docker run -p 3000:3000 -p 35729:35729 -v /path/to/trustroots/public:/home/trustroots/public -v /path/to/trustroots/app:/home/trustroots/app --link db:db_1 trustroots

Getting Started With Trust Roots Development

• Github
• See Offical Documentation for MEAN.js
• Our docs
• Install EditorConfig if possible

Understand these

Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:

• MongoDB - Go through MongoDB Official Website and proceed to their Official Manual, which should help you understand NoSQL and MongoDB better.
• Express - The best way to understand express is through its Official Website, particularly The Express Guide; you can also go through this StackOverflow Thread for more resources.
• AngularJS - Angular's Official Website is a great starting point. You can also use Thinkster Popular Guide, and the Egghead Videos.
• Node.js - Start by going through Node.js Official Website and this StackOverflow Thread, which should get you going with the Node.js platform in no time.

Community

• Join #trustroots on freenode.
• Ping us on Twitter and Facebook

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.