https://github.com/igorprado/angular-requirejs-gulp-express-mongodb-seed
MEAN using RequireJS Seed
https://github.com/igorprado/angular-requirejs-gulp-express-mongodb-seed
Last synced: about 1 year ago
JSON representation
MEAN using RequireJS Seed
- Host: GitHub
- URL: https://github.com/igorprado/angular-requirejs-gulp-express-mongodb-seed
- Owner: igorprado
- Created: 2014-08-15T04:05:18.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-04-22T18:34:50.000Z (about 11 years ago)
- Last Synced: 2025-04-07T13:05:28.833Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://beer-project.herokuapp.com/beers
- Size: 242 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AngularJS / RequireJS / Gulp / Express / MongoDB Seed
## Demo
Demo available: http://beer-project.herokuapp.com/beers
## About
I wanted to learn about:
* [NodeJS](http://nodejs.org/)
* [Express](http://expressjs.com/)
* [AngularJS](https://angularjs.org/)
* [MongoDB](https://www.mongodb.com/)
* [Gulp](http://gulpjs.com/)
So I started this seed! This seed is based on [Angular Express Seed](https://github.com/btford/angular-express-seed).
Express is used to serve the static files, templates to AngularJS and provide a RESTful API to manipulate MongoDB collections.
Gulp is used to build our frontend files (CSS, JS and optimize images).
## How to use this seed
### Install
Clone this repo:
git clone git@github.com:igorprado/angular-requirejs-gulp-express-mongodb-seed.git
Run `npm install` to install the dependencies:
npm install
Install Gulp globally:
npm install gulp -g
### Running the app
Build the frontend files running:
gulp
For development, use `gulp watch` to build the frontend files automatically.
Configure your MongoDB database and credentials on `app.js`:
mongoose.connect('mongodb://:@:/');
_NOTE: If you don't have a MongoDB on your development machine, a simple way to start with this app is create a free MongoDB instance at [Mongolab](https://mongolab.com/home)._
Runs like a typical express app:
node app.js
_For development enviroment, I recommend [Supervisor](https://github.com/isaacs/node-supervisor)._
### Running tests
I have to learn more about tests. So, it's on my roadmap for this seed.
## Directory Layout
app.js --> App config
package.json --> For npm
bower.json --> Frontend libs dependencies
frontend/ --> All of the source files to be used in on the client side (will be compiled on public/)
sass/ --> Stylesheet files
app.sass --> Default sass stylesheet
includes/ --> Divide our stylesheet in parts
img/ --> Image files
js/ --> Javascript files
app.js --> Declare top-level app module
main.js --> Default config for RequireJS
beers/ --> Our app is divided by modules. This is an example module
controllers/ --> All controllers of our module
services/ --> All services of our module
beers.js --> Declare our module and routes config
directives/ --> Define our application directives
lib/ --> Our bower dependencies are installed here
public/ --> Our genereted files will be placed here (after run gulp)
routes/
api.js --> Top-level route config
index.js --> Route for serving HTML pages and partials (AngularJS templates)
api/ --> All route configs of our modules will be here
beers.js --> Our example module route config.
views/
index.jade --> Main page for app, where the top-level ui-view is defined
layout.jade --> Doctype, title, head boilerplate
partials/ --> Angular view partials (partial jade templates)
index.jade --> The default state (for UI Router)
beers/ --> All the templates for our module are listed here
## Example App
A simple [beer management app](http://beer-project.herokuapp.com/beers) is running and using this seed.
## Support
Feel free to comment, fork or upgrade this code.
## License
MIT