ensl_gathers/README.md

44 lines
768 B
Markdown
Raw Normal View History

2015-08-19 13:54:20 +00:00
# ENSL Gathers App
## Status
2015-08-17 13:50:59 +00:00
A realtime micro web service to organise gathers for ENSL.org
2015-07-22 15:20:28 +00:00
## Design Goals
1) Create a nice place where the NS2 community can assemble and have fun
2015-07-29 10:47:01 +00:00
2015-07-22 15:20:28 +00:00
2) Create an efficient, easy-to-use and flexible system to create NS2 gathers
2015-07-29 10:47:01 +00:00
2015-07-22 15:20:28 +00:00
3) Support the modern web and basic usability expectactions (e.g. realtime, phone and tablet friendly)
That's it
2015-08-19 13:54:20 +00:00
## Requirements
2016-01-26 10:44:34 +00:00
- node.js > 4.0
2015-08-19 13:54:20 +00:00
- MongoDB
2016-01-26 10:44:34 +00:00
## Run in development
```bash
2016-01-26 10:44:34 +00:00
npm install # Install deps
2016-01-26 10:44:34 +00:00
npm run watch # Compile and watch frontend assets
RANDOM_USER=true npm run dev # Run dev server, loading yourself as a random user
```
## Run in production
```bash
npm install # Install deps
npm start_production # Compile assets and run in production
```
## License
MIT Licensed