1 | # EdenJS
|
2 | [![bitHound Overall Score](https://img.shields.io/bithound/code/github/eden-js/eden.svg?label=bitHound%20Overall%20Score&style=flat-square)](https://www.bithound.io/github/eden-js/eden)
|
3 | [![Issues](https://img.shields.io/github/issues/eden-js/eden.svg?style=flat-square)](https://github.com/eden-js/eden/issues)
|
4 | [![Dependencies](https://david-dm.org/eden-js/eden.svg?style=flat-square)](https://github.com/eden-js/eden)
|
5 | [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/eden-js/eden)
|
6 | [![Awesome](https://img.shields.io/badge/awesome-true-green.svg?style=flat-square)](https://github.com/eden-js/eden)
|
7 |
|
8 | Awesome isomorphic NodeJS skeleton for structured applications. Just have a look at the "bundles" that make up an EdenJS application.
|
9 |
|
10 | ## Getting Started
|
11 | These instructions will get a copy of the project up and running on your local machine.
|
12 |
|
13 | See deployment for notes on how to deploy the project.
|
14 |
|
15 | ### Prerequisites
|
16 | Required software to install and run EdenJS:
|
17 |
|
18 | * [Node.js](http://nodejs.org/)
|
19 | * [MongoDB](https://www.mongodb.com/)
|
20 | * [redis](https://redis.io/)
|
21 |
|
22 | ### Installation
|
23 | ```
|
24 | // Deploy EdenJS
|
25 | git init; git remote add origin https://github.com/eden-js/eden.git; git pull;
|
26 | ```
|
27 |
|
28 | ### Running the tests
|
29 | ```
|
30 | // Test EdenJS with NPM
|
31 | npm test;
|
32 | ```
|
33 |
|
34 | ### Deployment
|
35 | ```
|
36 | // Install (for production)
|
37 | gulp install;
|
38 |
|
39 | // Run in production
|
40 | node app;
|
41 | ```
|
42 |
|
43 | ### Tutorial
|
44 |
|
45 | A basic tutorial on how to get started with EdenJS is available: [TUTORIAL.md](TUTORIAL.md/)
|
46 |
|
47 | ## Built With
|
48 |
|
49 | * [Express](https://expressjs.com/) - Fast, unopinionated, minimalist web framework for Node.js.
|
50 | * [socket.io](https://socket.io/) - Node.js realtime framework server.
|
51 | * [Riot.js](https://riot.js.org/) - Simple and elegant component-based UI library.
|
52 | * [Mongorito](http://mongorito.com/) - MongoDB ODM for Node.js based on ES6 generators. No callbacks or promises.
|
53 |
|
54 | ## Versioning
|
55 | We use [SemVer](http://semver.org/) for versioning.
|
56 |
|
57 | ## Authors
|
58 | * **Alex Taylor** - *Lead Developer* - [EdenCoder](https://github.com/EdenCoder)
|
59 | * **Jack Taylor** - *Developer* - [OhYea777](https://github.com/OhYea777)
|
60 | * **Mike Mackenzie** - *Documentation* / *Developer* - [veb](https://github.com/veb)
|
61 |
|
62 | See also the list of [contributors](https://github.com/eden-js/eden/contributors) who participated in this project.
|
63 |
|
64 | ## License
|
65 | This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|