The base repo for bootstrapping Shardrealms Creation App and for following the project's development
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ISSUE_TEMPLATE.md
LICENSE
PULL_REQUEST_TEMPLATE.md
README.md

README.md

Shardrealms Creation App

Introduction

The Shardrealms Creation App, or SR Creation, is an Angular, Node.js, and MySQL web application for keeping track of complex relationships of elements within a dynamic story. In layman's terms, it's an application RPG game master can use to better keeping track of their campaign stories.

If you want to learn more about the vision of SR Creation, and the roadmap of development, you can read the SR Creation Trajectory documentation.

Usage

Currently, SR Creation is in alpha development and will not be useable by the general public for some time. Once ready, it will be deployed to a public server for use.

SR Creation can also be setup on a local server. Follow the setup instruction below for more details.

To access the individual github repos of each component, visit any of the links below:

Contribution

Are you interested in helping contribute to SR Creation? Email shardrealms@gmail.com and ask to join the Slack Shardrealms team. Also, please read the guide on how to contribute. This will help you get the information you need to start developing.

Feedback

Want to make a suggestion or report a bug? Open an issue with the details, and we'll be sure to look into it.

Setup

It is recommended that you run the Front-end, Server-side, and Database (see Usage) independently and under the recommended setup instructions found on each of those repos. All three must be running concurrently for the application to function as intended. See the individual repo's base README for more information on setup.

Demo

If you'd like to see a demo of how to set up the application and a run-down of its current features, you can watch the YouTube demo.