Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eden-js/cli
Awesome isomorphic NodeJS skeleton for structured applications
https://github.com/eden-js/cli
boilerplate eden express flux gulp isomorphic mongodb node nodejs riotjs
Last synced: 2 months ago
JSON representation
Awesome isomorphic NodeJS skeleton for structured applications
- Host: GitHub
- URL: https://github.com/eden-js/cli
- Owner: eden-js
- License: mit
- Created: 2015-03-17T06:23:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T15:15:01.000Z (about 2 years ago)
- Last Synced: 2024-11-11T21:35:24.628Z (2 months ago)
- Topics: boilerplate, eden, express, flux, gulp, isomorphic, mongodb, node, nodejs, riotjs
- Language: JavaScript
- Homepage: https://edenjs.com
- Size: 4.54 MB
- Stars: 25
- Watchers: 3
- Forks: 6
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# EdenJS
[](https://travis-ci.com/eden-js/cli)
[](https://github.com/eden-js/cli/issues)
[](https://github.com/eden-js/cli)
[](https://github.com/eden-js/cli)
[](https://discord.gg/5u3f3up)
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:
* [Node.js](http://nodejs.org/)
* [MongoDB](https://www.mongodb.com/)
* [redis](https://redis.io/)
### Installation
```
// Generate new project
npm i -g @edenjs/cli
mkdir project
cd project
edenjs init app
npm install --save @edenjs/core bootstrap
edenjs run
```
### Deployment
```
// Docker
docker build . -t edenjs/eden
docker push edenjs/eden
// Docker-Compose
Will deploy redis and mongodb locally for testing/development
docker-compose up -d
```
```
// kubernetes
Deploy redis and mongodb.
Our prefered method is via helm
// Install mongodb-replicaset
helm repo add stable https://kubernetes-charts.storage.googleapis.com/
helm install --name my-release stable/mongodb-replicaset
// Install redis
helm install stable/redis
Get the config values from these and edit config.js
// Create configmap
kubectl create configmap eden-configmap--from-file=config.js=config.js
// Deploy EdenJS
kubectl apply -f kubernetes.yml
// Optional for Continious Deployment
Will poll the registry every minute for image changes and do a rolling release on production
helm repo add keel-charts https://charts.keel.sh
helm repo update
helm upgrade --install keel --namespace=kube-system keel-charts/keel
```
### Running the tests
```
// Test EdenJS with NPM
npm test;
```
### Deployment
```
// Run in production
edenjs start
```
### Tutorial
A basic tutorial on how to get started with EdenJS is available: [TUTORIAL.md](TUTORIAL.md/)
## Built With
* [Express](https://expressjs.com/) - Fast, unopinionated, minimalist web framework for Node.js.
* [socket.io](https://socket.io/) - Node.js realtime framework server.
## Versioning
We use [SemVer](http://semver.org/) for versioning.
## Authors
* **Alex Taylor** - *Lead Developer* - [EdenCoder](https://github.com/EdenCoder)
* **installgen2** - *Webbed Toes* - [notgne2](https://github.com/notgne2)
* **Jack Taylor** - *Developer* - [OhYea777](https://github.com/OhYea777)
* **Mike Mackenzie** - *Documentation* / *Developer* - [veb](https://github.com/veb)
See also the list of [contributors](https://github.com/eden-js/cli/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.