parallel-stories / capstone

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Parallel Stories

Parallel Stories allows you to read and write stories with the feature to create alternate or parallel storylines. Lay the foundation for the roots of a story or contribute to existing story trees. Don’t hold back in integrating your personal experiences or wild imagination with Parallel Stories!

Version: 1.0.0

Deployed Link

Check out the app at https://parallel-stories.com/.

Built With

Based off firebones from https://github.com/queerviolet/firebones
React.js
Firebase
Material-UI
Quill.js
react-tree-graph
react-html-parser

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Install all dependencies after forking to your local machine:

yarn install
// OR
npm install

Use your own firebase database by replacing config information in /fire/index.js:

var config = {
  apiKey: /* You apiKey here */,
  authDomain: /* You authDomain here */,
  databaseURL: /* You database URL here */,
  projectId: /* You projectId here */,
  storageBucket: /* You storageBucket here */,
  messagingSenderId: /* You messagingSenderId here */
}

Seed your database with provided seed file database_seed.json by importing into your firebase database data.

Run development environment:

// Method 1:
npm run build-watch
npm start

// Method 2:
npm run build-dev

Go to localhost:5000 in browser to see web application running.

Testing

Test componenets and firebase calls once:

npm run test

Watch and run tests:

npm run test-watch

Contributing

Please read the Contribution Guide for details on our code of conduct and process for issues and pull requests.

Authors

License

This project is licensed under the MIT license.

About

License:MIT License


Languages

Language:JavaScript 93.9%Language:CSS 3.6%Language:Shell 1.4%Language:HTML 1.1%