Git Product home page Git Product logo

Stories in Ready

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

relational schema

Contributing

See CONTRIBUTING.md for contribution guidelines.

family-thief's Projects

pebbleframe icon pebbleframe

Easily compare reviews and prices to make informed purchasing decisions

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.