ensl_gathers/README.md

54 lines
999 B
Markdown

# SWS Gather App
## Status
A stateless, flexible and realtime micro web service to arrange SWS gathers for ENSL.org
## Design Goals
I'm making this app to promote 3 things
1) Create a nice place where the NS2 community can assemble and have fun
2) Create an efficient, easy-to-use and flexible system to create NS2 gathers
3) Support the modern web and basic usability expectactions (e.g. realtime, phone and tablet friendly)
That's it
## Run
```bash
npm install
npm start
```
## Todo
Required for Production:
- ENSL.org: Authentication
- Admin tools: Modify Messages
- Admin tools: Remove gatherer
- ENSL.org: Pull bans
Nice to have:
- Hive.naturalselection2.com: Pull stats
- Steam: Outbound steam messaging
- Backend store for gathers
- Add sounds and configuration
- Add user profile + backend store
- Show online/away/offline status
- Picking order
## Node Version
node 0.12 or greater
Upgrade to io.js when arrow functions are no longer behind flag
## License
MIT Licensed