Skip to content

Latest commit

 

History

History
129 lines (96 loc) · 6.66 KB

README.md

File metadata and controls

129 lines (96 loc) · 6.66 KB
Raw

Deprecated

Development of this project is now frozen. A much better boilerplate can now be found at https://github.com/mgenev/how-to-sane which uses the SANE stack and is almost updated with all the features that this one has. All future development is going there.

What is Nodember?

It is a boilerplate, a sand box and a toolbox. It demonstrates how to make a full stack javascript application using Node and Ember, Express and MongoDB. The architecture is MVC-MVC and REST for communicaton.

Past the basics Nodember features an ever-expanding demonstration of common needs in web development and how they are implemented in this stack:

  • CRUD
  • User authentication
  • Data relationships
  • Embedded records
  • File uploads
  • Drag and Drop
  • Photo gallery and viewer
  • App level flash messaging
  • Data bound modals
  • Basic CMS functionality (being built)
  • Many more coming

What Nodember isn't?

It is not production-ready. It is not fully secure for sensitive data. It is not infrastructure for building real apps and APIs like ember-cli or sails.js. It is not official software and it doesn't follow the best practices for such.

In a nutshell use it to learn techniques and to experiment, but do not deploy it for real live projects. In those cases use appropriately engineered community tools for infrastructure.

How is it made?

Core components

  • Node - Server Side
  • Express - Web Server Framework
  • Ember - Client Side MVC Framework
  • MongoDB - Database

Additional Tools Available

  • Bootstrap - front end framework
  • SASS - CSS pre-processor
  • jQuery - Write less, do more
  • Grunt - The Javascript task runner
  • Bower - Client-side dependency management
  • Handlebars - Advanced templating
  • Livereload - Automatic browser reload per save
  • Mongoose - A NodeJS object modeler for MongoDB
  • Passport - User Authentication
  • Font Awesome - CSS Icons

Before You Begin

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

Prerequisites

Make sure you have installed all these prerequisites on your development machine.

  • Node.js - Download & Install Node.js and the npm package manager, if you encounter any problems, you can also use this Github Gist to install Node.js.
  • MongoDB - Download & Install MongoDB, and make sure it's running on the default port (27017).
  • Bower - You're going to use the Bower Package Manager to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm:
$ npm install -g bower
  • Grunt - You're going to use the Grunt Task Runner to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
$ sudo npm install -g grunt-cli

Quick Install

Once you've installed all the prerequisites, you're just a few steps away from starting to develop your Full Stack JS application.

The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application, to learn more about the modules installed visit the NPM & Package.json section.

To install Node.js dependencies you're going to use npm again, in the application folder run this in 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.
  • Finally, when the install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application

Running Your Application

After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:

$ grunt

Your application should run on the 3000 port so in your browser just go to http://localhost:3000

Acknowledgements

The Full Stack JS Boilerplate is created by Martin Genev of Gemini Connect and is largely based on the work of Amos Haviv on meanjs.org

License

The MIT License (MIT)

Copyright (c) 2014 Gemini Connect LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Codeship Status for mgenev/nodember