Skip to content
forked from JKTOpen/destiny

DESTINY: Full-stack javascript ecommerce application

License

Notifications You must be signed in to change notification settings

scrock1987/destiny

 
 

Repository files navigation

DESTINY is a Full-stack javascript ecommerce application built with mean.io framework.

Prerequisites

  • Node.js - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm
  • MongoDB - Download and Install MongoDB - Make sure mongod is running on the default port (27017).

Tools Prerequisites

  • NPM - Node.js package manage; should be installed when you install node.js.
  • Bower - Web package manager. Installing Bower is simple when you have npm:
$ npm install -g bower

Optional Built with Grunt

  • Grunt - Download and Install Grunt.
$ npm install -g grunt-cli

Quick Install

The quickest way to get started with DESTINY is to install the meanio package from NPM.

Install MEAN CLI, clone destiny repo & install dependency:

$ npm install -g mean-cli
$ git clone https://github.com/plannifnminus1fails/destiny.git
$ cd destiny && npm install

We recommend using Grunt to start the server:

$ grunt

If grunt aborts because of JSHINT errors, these can be overridden with the force flag:

$ grunt -f

Alternatively, when not using grunt you can run:

$ node server

Then, open a browser and go to:

http://localhost:3000

Troubleshooting

During install some of you may encounter some issues.

Most issues can be solved by one of the following tips, but if are unable to find a solution feel free to contact us via the repository issue tracker or the links provided below.

Update NPM, Bower or Grunt

Sometimes you may find there is a weird error during install like npm's Error: ENOENT. Usually updating those tools to the latest version solves the issue.

  • Updating NPM:
$ npm update -g npm
  • Updating Grunt:
$ npm update -g grunt-cli
  • Updating Bower:
$ npm update -g bower

Cleaning NPM and Bower cache

NPM and Bower has a caching system for holding packages that you already installed. We found that often cleaning the cache solves some troubles this system creates.

  • NPM Clean Cache:
$ npm cache clean
  • Bower Clean Cache:
$ bower cache clean

Configuration

All configuration is specified in the config folder, through the env files, and is orchestrated through the meanio NPM module. Here you will need to specify your application name, database name, and hook up any social app keys if you want integration with Twitter, Facebook, GitHub, or Google.

Environmental Settings

There is a shared environment config: all.

  • root - This the default root path for the application.
  • port - DEPRECATED to http.port or https.port.
  • http.port - This sets the default application port.
  • https - These settings are for running HTTPS / SSL for a secure application.
    • port - This sets the default application port for HTTPS / SSL. If HTTPS is not used then is value is to be set to false which is the default setting. If HTTPS is to be used the standard HTTPS port is 443.
    • ssl.key - The path to public key.
    • ssl.cert - The path to certificate.

There are three environments provided by default: development, test, and production.

Each of these environments has the following configuration options:

  • db - This is where you specify the MongoDB / Mongoose settings
  • app.name - This is the name of your app or website, and can be different for each environment. You can tell which environment you are running by looking at the TITLE attribute that your app generates.
  • Social OAuth Keys - Facebook, GitHub, Google, Twitter. You can specify your own social application keys here for each platform:
    • clientID
    • clientSecret
    • callbackURL
  • emailFrom - This is the from email address displayed when sending an email.
  • mailer - This is where you enter your email service provider, username and password.

To run with a different environment, just specify NODE_ENV as you call grunt:

$ NODE_ENV=test grunt

If you are using node instead of grunt, it is very similar:

$ NODE_ENV=test node server

To simply run tests

$ npm test

NOTE: Running Node.js applications in the production environment enables caching, which is disabled by default in all other environments.

Getting Started

###We pre-included an article package example. Check out:

###You may start working on product package. You can find it at packages/custom/product. For working example checkout this; http://localhost:3000/#!/product/help

About

DESTINY: Full-stack javascript ecommerce application

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.6%
  • CSS 10.4%