https://github.com/danivek/mean-starter-kit

Starter kit (seed) for MEAN stack applications - MongoDB, Express, AngularJS, NodeJS, Gulp 4, Docker
https://github.com/danivek/mean-starter-kit

Last synced: about 1 year ago
JSON representation

Starter kit (seed) for MEAN stack applications - MongoDB, Express, AngularJS, NodeJS, Gulp 4, Docker

• Host: GitHub
• URL: https://github.com/danivek/mean-starter-kit
• Owner: danivek
• Created: 2015-11-02T12:41:01.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-08-04T14:01:26.000Z (almost 10 years ago)
• Last Synced: 2025-04-02T20:11:18.293Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 19
• Watchers: 5
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# mean-starter-kit

[![Build Status](https://travis-ci.org/danivek/mean-starter-kit.svg?branch=master)](https://travis-ci.org/danivek/mean-starter-kit)

[![Coverage Status](https://coveralls.io/repos/danivek/mean-starter-kit/badge.svg?branch=master&service=github)](https://coveralls.io/github/danivek/mean-starter-kit?branch=master)

[![Dependency Status](https://david-dm.org/danivek/mean-starter-kit.svg)](https://david-dm.org/danivek/mean-starter-kit) [![devDependency Status](https://david-dm.org/danivek/mean-starter-kit/dev-status.svg)](https://david-dm.org/danivek/mean-starter-kit#info=devDependencies)

> Starter kit (seed) for MEAN stack applications - MongoDB, Express, AngularJS, NodeJS with Gulp

## Features

Client:

  - [AngularJS](https://angularjs.org/)

  - [AngularJS UI Router](https://github.com/angular-ui/ui-router)

  - [John Papa's Angular styleguide](https://github.com/johnpapa/angular-styleguide)

  - [Bootstrap](http://getbootstrap.com/)

  - [angular-translate](https://github.com/angular-translate/angular-translate) (i18n)

  - Preconfigure i18n translations, with loading locale from the browser language.

  - And more... See bower_components file.

Server:

  - [Express](http://www.http://expressjs.com/)

  - [node-config](https://github.com/lorenwest/node-config)

  - [CORS](https://github.com/expressjs/cors)

  - [Mongoose](http://mongoosejs.com/)

  - CRUD exemple

  - And more... See package.json file.

Tests:

  - [Mocha](https://mochajs.org/) Tests

  - [Istanbul](https://github.com/gotwarlost/istanbul) code coverage

  - [Supertest](https://github.com/visionmedia/supertest)

Build:

  - [Gulp 4](http://gulpjs.com/) include various gulp plugins

  - [Browsersync](http://www.browsersync.io/) with livereload for client

  - [Nodemon](http://nodemon.io/) with livereload for server

  - Lint code with eslint (help enforce a uniform coding style)

  - Cache control with [gulp-rev](https://github.com/sindresorhus/gulp-rev)

  - Run mocha tests with code coverage

  - Application distribution build (dist folder)

  - travis.yml

  - And more... See gulpfile.js and gulp-tasks folder

Docker:

  - DockerFile with node 4 official image

  - docker-compose.yml version 2 with official MongoDb and Nginx images

  - Nginx configuration with caching

**Coming soon:**

  - **e2e tests** with [protractor](http://www.protractortest.org/#/)

  - ...

## AngularJS best practices used

  - [$httpProvider.useApplyAsync(true)](http://blog.thoughtram.io/angularjs/2015/01/14/exploring-angular-1.3-speed-up-with-applyAsync.html)

  - [$compileProvider.debugInfoEnabled(false)](https://docs.angularjs.org/guide/production)

  - Avoid [FOUC - Flash of untranslated content](https://angular-translate.github.io/docs/#/guide/12_asynchronous-loading#asynchronous-loading_fouc---flash-of-untranslated-content) with angular-translate by adding [translate-cloak directive](https://angular-translate.github.io/docs/#/api/pascalprecht.translate.directive:translateCloak). See [commit](https://github.com/danivek/mean-starter-kit/commit/ae8099d9177e36322f97d30401ed1b81fffe222f).

## Prerequisites

  * MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - If you plan on scaffolding your project with mongoose, you'll need mongoDB to be installed and have the `mongod` process running.

## Getting Started

- Install: `npm install` and `bower install`

- Run: `npm start` or if you have Gulp 4 on your environnement, just run: `gulp`

- Run tests: `npm test` or if you have Gulp 4 on your environnement, just run: `gulp test`

- Build dist: `npm dist`

## Contribute

When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).