https://github.com/swingdev/mean-starter

https://github.com/swingdev/mean-starter

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/swingdev/mean-starter
• Owner: SwingDev
• License: mit
• Created: 2014-06-06T14:31:08.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-16T08:34:10.000Z (almost 10 years ago)
• Last Synced: 2024-03-02T16:20:21.300Z (11 months ago)
• Language: CoffeeScript
• Size: 492 KB
• Stars: 0
• Watchers: 19
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
MEAN-starter

============

![jelly](https://www.evernote.com/shard/s16/sh/35bf1b4e-c351-4a98-a64d-c0618e8e2b43/6b0929e02f255aaf815acefecc653e3e/deep/0/north-america-lions-mane-jellyfish-625x450.jpg-625-450-pixels.png)

## Installing

Make sure you have node, npm and mongodb installed.

First go `npm install` and `bower install`

Take a look at `./.jenkins/build.sh` to see what else is needed. 

## Starting MongoDB

Make sure you have `.data/db` directory present, then go `npm run mongo`.

## Running

We use `node-dev` to run server, it will restart your express server every time files change. Run server using `npm start` command. 

We use brunch to build front-end stuff (`brunch watch`).

We use gulp to compile backend coffee (`gulp watch`)

## Debugging

Run `npm run debug`

OSX MongoDB browser: [Robomongo](http://robomongo.org)

Ng-inspector for your browser [ng-inspector](http://ng-inspector.org)

## Testing

Run `npm test`

Run `npm run e2e_test`

## User API

Differences from express-user-couchdb:

* No email verify.

* No groups.

* Single user attribute `isAdmin` giving user superpowers.

### Brief summary of API methods

Go to `routes/user.coffee` and look at the comments. You will probably have to change stuff in passwor reset controller, to match your domain, port, templates and frontend url schema.

## Configuring

All configs should be imported from from `config/config` file. 

The file imports config from other files in following order (config in later files will overwrite config from previous files):

* `config/env/all` - store your general config there

* `config/env/[dev|production|staging|test]` - store config specific for environment there. The environment is chosen based on value of `NODE_EVN` process env variable. 

* `config/secrets` - this file should not be tracking on git and you should keep all password and secret API keys there.