README.md

InkWell

A collaborative writing platform

Team

• Product Owner: Brandon Ellis
• Scrum Master: Adam Van Antwerp
• Development Team Members: Henry Ng, Craig Smith

Table of Contents

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

Usage

• Download and unzip the repository.
• Install dependencies.
• Rename /server/config/dbConfig.example.js to be dbConfig.js
• Edit dbConfig.js to point to a valid relational database (sequelize supports quite a few, see this page for examples and instructions on configuring the ORM)
• Rename /server/config/secret.example to secret and replace the content with a new secret string. Try making it long and not comprised of discernable words.
• Start the server from the base directory with node server\app.js.

Requirements

• Node 0.10.x
• MySQL, MariaDB, SQLite, PostgreSQL or MS SQL

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here.
View the project commit history here.

Database Schema

Contributing

See CONTRIBUTING.md for contribution guidelines.