cory2067 / onionvale

A simple collaborative text-based adventure web platform

onionvale

a simple collaborative text-based adventure platform designed for play be 2E

for any feature requests or bug reports, open issues for this repo

for a comprehensive documentation on how I designed/developed this application, check out documentation.md

Design Considerations

onionvale is designed for play by 2E, a small community of friends. as such, this implementation stresses less on enforcing community rules (such as not allowing replies to one's own message or timeouts before another message). instead, i've tried to create much more of an open platform for the community to iterate, be creative, and follow an honor system. this system, of course, is much less viable when the community grows much larger. i have, however, prevented javascript and html injection, but with certain exceptions

Development

1. install Node.js and MongoDB
2. npm install dependencies
3. cp example.config.js config.js
4. set the appropraite environment variables in config.js
5. mkdir db
6. mongod --dbpath db & # Have the mongo daemon run in the background
7. npm start to run local instance on localhost:8080

Deploying with Docker

1. obtain a copy of the production config.js from an onionvale developer
2. docker build -t onionvale .
3. docker run onionvale
4. onionvale will run on port 80. to run in the background, use docker run -d onionvale