Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.06 KB

README.md

File metadata and controls

60 lines (46 loc) · 2.06 KB
Raw

Line4Line

This app allows people to write a story together one line at a time -- with a twist. The user whose turn it is to write can only see the most previously written line in the story. This limited context makes for random stories that do not make sense but do make you laugh.

##Tech

  • Node
  • Express
  • React
  • Mongo
  • Socket.io

##Features we wanted to add but didn't have time

  • The current implementation of Socket.io only allows for one active story at a time. Look into channels to solve this.
  • Use Socket to update the lobby when a new story is created.
  • Use Socket to display to the user how many turns they still have to wait.
  • Allow users to create private stories that only their friends can join.
  • A profile page where the user can see all the stories he/she contributed to.
  • Invite your friends from Facebook.
  • Share stories on Facebook.

#Starting It Up

npm install

Start up the Express server on port 8081 with npm start.

##Facebook Auth You will need to create an app at developers.facebook.com for Facebook authentication to work. Add all of your team members as developers to this app. Facebook will generate an App ID and App Secret for you.

Create a file named secretsecrets.js and save it in the server folder. Make sure this file is in your .gitignore. This file should have the following:

module.exports = {
 appId : your-fb-app-id,
 appSecret : 'your-fb-secret',
 secret : 'your-secret'
}

The appId will be a number. appSecret and secret should be strings. The secret can be whatever you want as long as it is a string.

##Starting up MongoDB We recommend creating a folder on your desktop with the name of your db. Then cd to your desktop and run:

mongod --dbpath=./your-db-name --port=51707

The models/config.js calls for an environment variable that is a pathway to your database. Run this line in the terminal:

export DBPATH='mongodb://localhost:51707/line4line'

From there you can open a new terminal tab and run:

mongo

The you can type show dbs to see all your databases. Then type use line4line.