/eden

Awesome isomorphic NodeJS skeleton for structured applications

Primary LanguageJavaScriptMIT LicenseMIT

EdenJS

bitHound Overall Score Issues Dependencies License Awesome

Awesome isomorphic NodeJS skeleton for structured applications. Just have a look at the "bundles" that make up an EdenJS application.

Getting Started

These instructions will get a copy of the project up and running on your local machine.

See deployment for notes on how to deploy the project.

Prerequisites

Required software to install and run EdenJS:

Installation

// Deploy EdenJS
git init; git remote add origin https://github.com/eden-js/eden.git; git pull;

Running the tests

// Test EdenJS with Yarn
yarn test;

// Test EdenJS with NPM
npm test;

Deployment

// Install (for production)
gulp install;

// Run in production
node app;

Tutorial

A basic tutorial on how to get started with EdenJS is available: TUTORIAL.md

Built With

  • Express - Fast, unopinionated, minimalist web framework for Node.js.
  • socket.io - Node.js realtime framework server.
  • Riot.js - Simple and elegant component-based UI library.
  • Mongorito - MongoDB ODM for Node.js based on ES6 generators. No callbacks or promises.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Authors

  • Alex Taylor - Lead Developer - EdenCoder
  • Jack Taylor - Developer - OhYea777
  • Mike Mackenzie - Documentation / Developer - veb

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.