PublishUs

Simple document editing with the power of git.

Team

• Product Owner: Justin Mendelson
• Scrum Master: Franklin Jeng
• Development Team Members: Simon Huang, Abiy Melaku

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Create projects together with organization and structure. Gated process prevents overwritting changes made with each other.

Requirements

• Node 0.10.x
• React 15.4.x
• MySQL 5.7.x
• Express 4.10.x
• nodegit 0.17.x

Development

Installing Dependencies

Have a MySQL server started:

mysql.server start

Upon first run, a database needs to be created: Sign into mysql database, by default the command is:

mysql -u root -p

With a blank password

Once inside, create a database for use

CREATE DATABASE publishus;

From within the root directory:

npm install

Start the server with:

npm start

Start tests with:

npm test

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.