code-friends/CodeFriends

Code Friends is a collaborative programming environment with real-time concurrent editing, and text/video chat. Collaborate with others remotely and see your changes sync instantly. Think of it as Google Docs for your sublime text editor.

CodeFriends

CodeFriends is a collaborative programming environment in your browser. Work with others in real time over text or video chat, clone in repos from Github, and see the changes instantly when a collaborator edits the project.

Team

• Project Lead and Back End Engineer: Jorge Silva
• Back End and Database Engineer: Chase Ellsworth
• Front End Lead and Scrum Master: Catherine Bui
• Full Stack Developer: Doug Phung

Table of Contents

1. Usage
2. Development
   1. Setup
   2. Running
   3. Testing
3. Contributing
4. License

Usage

1. Login with Github or create an account.
2. Clone a repo, use a template, or create a project from scratch.
3. Invite collaborators with their Github username and start collaborating!

Development

Setup

Install mysql and RethinkDB

brew install mysql rethinkdb

Install mocha and gulp

npm install -g mocha gulp nodemon

Install all packages and bower components

npm install
bower install

Compile frontend assets

gulp

Running

Once you startup MySQL and RethinkDB, you're now ready to start the app. Please make sure both databases are running before starting the app.

Running for development (using nodemon):

npm run dev

Running on production (using forever):

npm start

Testing

npm test

Contributing

See CONTRIBUTING.md for contribution guidelines.

License

MIT License 2014