README

groupwrite.io is a collaborative writing game. You connect to the server (via browser, no install needed). The server then quickly matches you with a few fellow players to form a new writing group. All members of the writing group are online now, and start collaborating on writing a new story. The game works in rounds: in each round, players suggest different continuations to the current, ongoing story.

Every player sees in real time what every other player is writing, and can vote on his preferred continuation to the current plot. Once a particular continuation gets enough votes, it gets added to the ongoing story, and the round finishes (round often take around one minute). When a player suggests “The End” of the story, and his suggestions gets enough votes, the game and the story end.

The end result is a collaboratively created story.

• Follow Our Blog for updates
• Current Tasks
• Slack
• A sample story created with groupwrite.io
• Give us a ⭐

Dependencies / Tech Stack

• git
• Node
• Express web server
• Vue frontend framework
• Socket.io for realtime communications / websockets
• Webpack for bundling everything up
• Babel / ES2016 for modern Javascript
• eslint for quality control
• mocha for testing, Nightmare for web testing
• CircleCI for Continous Integration & Deployment
• Slack for communications
• Medium for blogging

How do I get set up?

• git pull
• npm install
• npm start
• http://localhost:3000/
• (See also admin screen at http://localhost:3000/admin)

Contribution guidelines

• We're having weekly coding sessions in Tel Aviv, usually on Thursday evening or Friday noonish. You're welcome to join!
• Start by looking at some of our starter tasks, high-priority and medium-priority tasks.

TBD:

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

For any questions, contact Ron Gross (chiefninjaofficer@gmail.com, +972-52-6558841)

Potential P.R venues / Storythons

• http://tisch.nyu.edu/itp

OKRs for March 31 2017

• Launch Alpha ** Deployed server that anyone can play on
• Produce 3 decent stories ** Each story gets 50 page views

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm start

# build for production with minification
npm run build

# run unit tests
npm run unit

# run e2e tests
npm run e2e

# run all tests
npm test

For detailed explanation on how things work, checkout the guide and docs for vue-loader.