Twine

Github for Documents. For additional info, read our press release.

Table of Contents

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

Roadmap

View the project roadmap

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 twine;

From within the root directory:

npm install

Start the server with:

npm start

Run front end tests with:

npm run-script testf

Run back end tests with:

npm run-script testb

Contributing

See CONTRIBUTING.md for contribution guidelines.

Team

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