muddaserahmed / gramercylite Goto Github PK

gramercy-lite is a full-stack JavaScript open-source application, that is built upon MongoDB, Node.js, Express, and AngularJS. The app is developed as a demo for the test assignment. It is the extremly basic version of gramercy.io created in approximately one day.

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• Node.js - Download & Install Node.js and the npm package manager. If you encounter any problems, you can also use this GitHub Gist to install Node.js.
• MongoDB - Download & Install MongoDB, and make sure it's running on the default port (27017).
• Bower - You're going to use the Bower Package Manager to manage your front-end packages. Make sure you've installed Node.js and npm first, then install bower globally using npm:

$ npm install -g bower

To install the dependencies, run this in the application folder from the command-line:

```bash
$ 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.
• When the npm packages install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application
• To update these packages later on, just run npm update

Run your application using npm:

$ npm start

Your application should run on port 3000 with the development environment configuration, so in your browser just go to http://localhost:3000

That's it! Your application should be running. To proceed with your development, check the other sections in this documentation. If you encounter any problems, try the Troubleshooting section.

Explore config/env/development.js for development environment configuration options.

To run your application with production environment configuration:

$ npm run start:prod

Explore config/env/production.js for production environment configuration options.

To have default account(s) seeded at runtime:

In Development:

MONGO_SEED=true npm start

It will try to seed the users 'user' and 'admin'. If one of the user already exists, it will display an error message on the console. Just grab the passwords from the console.

In Production:

MONGO_SEED=true npm start:prod

This will seed the admin user one time if the user does not already exist. You have to copy the password from the console and save it.

Application will start by default with secure configuration (SSL mode) turned on and listen on port 8443. To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:

$ npm run generate-ssl-certs

Windows users can follow instructions found here. After you've generated the key and certificate, place them in the config/sslcerts folder.

Finally, execute prod task npm run start:prod

• enable/disable SSL mode in production environment change the secure option in config/env/production.js

You can run the full test suite included with gramercy-lite with the test task:

$ npm test

This will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/).

To execute only the server tests, run the test:server task:

$ npm run test:server

To execute only the server tests and run again only changed tests, run the test:server:watch task:

$ npm run test:server:watch

And to run only the client tests, run the test:client task:

$ npm run test:client

The gramercy-lite project integrates Gulp as build tools and task automation.

We have wrapped Gulp tasks with npm scripts so that regardless of the build tool running the project is transparent to you.

To use Gulp directly, you need to first install it globally:

$ npm install gulp -g

Then start the development environment with:

$ gulp

To run your application with production environment configuration, execute gulp as follows:

$ gulp prod

It is also possible to run any Gulp tasks using npm's run command and therefore use locally installed version of gulp, for example: npm run gulp eslint

• Install Docker

• Install Compose

• Local development and testing with compose:

$ docker-compose up

• Local development and testing with just Docker:

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

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

$ docker run -p 3000:3000 -p 35729:35729 -v /Users/mdl/workspace/mean-stack/mean/public:/home/mean/public -v /Users/mdl/workspace/mean-stack/mean/app:/home/mean/app --link db:db_1 mean

• Production deployment with compose:

$ docker-compose -f docker-compose-production.yml up -d

• Production deployment with just Docker:

$ docker build -t mean -f Dockerfile-production .
$ docker run -p 27017:27017 -d --name db mongo
$ docker run -p 3000:3000 --link db:db_1 mean