MEAN.JS - Full-Stack JavaScript Using MongoDB, Express, AngularJS, and Node.js -
JavaScript HTML Other
Latest commit f838404 Dec 25, 2016 @lirantal lirantal committed on GitHub fix(mongoose): fixing mongoose deprecation notice for promises lib (#…
…1691)

If no promises library set correctly for the mongoose.Promise property then the following warning notice is omitted by mongoose:
`DeprecationWarning: Mongoose: mpromise (mongoose's default promise library) is deprecated, plug in your own promise library instead: http://mongoosejs.com/docs/promises.html`
Permalink
Failed to load latest commit information.
.github feat(core): Move template to .github folder Sep 15, 2016
config fix(mongoose): fixing mongoose deprecation notice for promises lib (#… Dec 25, 2016
modules Better autofocus (#1664) Dec 14, 2016
public Remove executable bit when not necessary Feb 16, 2015
scripts chore(tidy): tidying up minor lint and layout issues Sep 9, 2016
.bowerrc eat(core): use npm commands Jul 9, 2016
.csslintrc formatting reboot (space-2 and consistency) Jul 31, 2015
.dockerignore fix(docker): Update dockerfile for development and production (#1491) Sep 9, 2016
.editorconfig fix(editorconfig): Fix file path patterns (#1362) Jun 13, 2016
.eslintrc.js * feat(core): node engine update, adding cleanup and reinstall npm sc… Oct 15, 2016
.gitignore feat(build): Ignore compiled sass/less files from git (#1592) Oct 29, 2016
.slugignore Add missing newline at the end of text files Feb 16, 2015
.travis.yml feat(ci): Test for Node v7 (allow failure) (#1596) Oct 25, 2016
CHANGELOG.md * chore(release): bumping to version 0.5.0 Oct 21, 2016
CONTRIBUTING.md fix(core): updating instructions on how to generate the changelog for… Oct 21, 2016
Dockerfile feat(docker): cleaning up pkgs and enabling npm install for dev env (#… Oct 30, 2016
Dockerfile-production feat(docker): cleaning up pkgs and enabling npm install for dev env (#… Oct 30, 2016
LICENSE.md Move license to it's own file. Easier to see what the license is when… Apr 14, 2014
Procfile feat(forever): removing forever dependency (#1409) Jul 24, 2016
README.md doc(readme): wear the Snyk badge with pride! (#1583) Oct 19, 2016
UPGRADE.md fix(users): GitHub strategy missing email (#1250) Apr 29, 2016
bower.json fix(users): Better MIME-type checking, remove image cropping library (#… Nov 15, 2016
docker-compose-production.yml feat(docker): Add Dockerfile for production Aug 25, 2016
docker-compose.yml feat(debug): replacing deprecated gulp-node-inspector with vanilla no… Oct 13, 2016
gulpfile.js feat(build): Ignore compiled sass/less files from git (#1592) Oct 29, 2016
karma.conf.js fix(tests): Reorganized coverage tests (#1480) Sep 5, 2016
manifest.yml Switched to using new MongoDB service in Bluemix since MongoLabs is b… Nov 2, 2015
package.json * chore(release): bumping to version 0.5.0 Oct 21, 2016
protractor.conf.js adding protractor options to fix travis failing Oct 6, 2015
server.js Refactoring server application service to enable modularity and callb… Jul 30, 2015
test.js feat(config): Deprecate JSHint in favor of ESLint Mar 15, 2016

README.md

MEAN.JS Logo

Gitter Build Status Dependencies Status Coverage Status Known Vulnerabilities

MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for MongoDB, Node.js, Express, and AngularJS based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.

Before You Begin

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

Prerequisites

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

$ npm install -g bower

Downloading MEAN.JS

There are several ways you can get the MEAN.JS boilerplate:

Cloning The GitHub Repository

The recommended way to get MEAN.js is to use git to directly clone the MEAN.JS repository:

$ git clone https://github.com/meanjs/mean.git meanjs

This will clone the latest version of the MEAN.JS repository to a meanjs folder.

Downloading The Repository Zip File

Another way to use the MEAN.JS boilerplate is to download a zip copy from the master branch on GitHub. You can also do this using the wget command:

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

Don't forget to rename mean-master after your project name.

Yo Generator

Another way would be to use the Official Yo Generator, which generates a copy of the MEAN.JS 0.4.x boilerplate and supplies an application generator to ease your daily development cycles.

Quick Install

Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop your MEAN application.

The boilerplate comes pre-bundled with a package.json and bower.json files that contain the list of modules you need to start your application.

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

$ 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

Running Your Application

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.

Running in Production mode

To run your application with production environment configuration:

$ npm run start:prod

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

Running with User Seed

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.

Running with TLS (SSL)

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

Testing Your Application

You can run the full test suite included with MEAN.JS 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

Running your application with Gulp

The MEAN.JS 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

Development and deployment With Docker

  • 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 deploy with Docker

  • 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

Getting Started With MEAN.JS

You have your application running, but there is a lot of stuff to understand. We recommend you go over the Official Documentation. In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development process. We tried covering as many aspects as possible, and will keep it updated by your request. You can also help us develop and improve the documentation by checking out the gh-pages branch of this repository.

Community

Contributing

We welcome pull requests from the community! Just be sure to read the contributing doc to get started.

Credits

Inspired by the great work of Madhusudhan Srinivasa The MEAN name was coined by Valeri Karpov.

License

The MIT License