Skip to content
A realtime collaborative writing game
JavaScript Vue HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
api
build
config
src
static
test
util
.babelrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.npmrc
LICENSE.md
Marketing.md
Procfile
README.md
circle.yml
index.html
package.json

README.md

README

CircleCI CII Best Practices

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.

Game page

Dependencies / Tech Stack

How do I get set up?

Database setup

The default setup uses the mongo-in-memory database, which cleans on every code edit. If you want persistant data:

  1. Install a local MongoDB server
  2. Create a new local file config/local.secret.config.js with
module.exports = {
  // This overrides dev.secret.config.js
  mongoConnectionString: 'mongodb://localhost:27017/groupwrite-dev'
}

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 (ron.gross@gmail.com, +972-52-6558841)

Marketing

See Our Marketing Plan

OKRs

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  (TBD: Not currently used)

# run all tests
npm test

# run unit tests
npm run unit

# run e2e tests
npm run e2e
You can’t perform that action at this time.