Skip to content

cameronpenner/CharacterSheetsOnline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

RPG Companion App

Instructions for Marker

We have been using our Trello board for big-picture user stories, and splitting them up into smaller stories, developer tasks, and bugs using our iteration 3 git issues, where we post about the cost and priority, and assign each to a team member. Our evaluation of last iteration's process and things to change for this iteration on this trello board.

Our app is currently being hosted on AWS and on Meteor.

Our DDP documentation and justification of it over REST can be found here.

Please use the master branch for marking.

Project Overview

Our app is based on the Meteor platform, which uses Javascript for both client and server code. Within Meteor, we are using React.js for UI layout and logic.

See the following links for more documentation:
Project Vision
Technology
User Flow Map
Database Model
Database Relationships
Meteor Diagram
Architecture Diagram

User Stories

Big user stories

Meeting Minutes

Meeting history

Please note that electronic discussion regarding the project is recorded in a Slack channel. Please contact a team member for an invite (we would need your email).

Installation

This installation guide is based on the Meteor Installation Guide. On OSX or Linux, use curl https://install.meteor.com/ | sh to install the latest version of the Meteor Dev Kit. Once meteor is installed, clone this repository and cd into the MeteorApp/ directory and type meteor. The app will build and provide server output in the terminal. The web app will be available at localhost:3000.

Versions and Dependencies

Our app is built on Meteor 1.2.1 and externally depends on Node v0.10.40. It internally stores package dependencies and versions

Design Pattern

Our app code is found in the MeteorApp/ directory, and is organized into client/, server/ and both/ directories, for code that runs on the client, server, and both the client and server, respectively. Within each of these directories are directories such as character/ and campaign/ which specify which functional part of the app or user story the code within them is for. Unit and integration tests are separated into the MeteorApp/tests/ directory and are run automatically within the app when it is built.

An additional note on our project's design pattern can be found here.

End-to-End Tests (Selenium)

We have built a full test suite using the Selenium binding for Java in the Selenium/ folder. Run the Meteor app locally in production mode using meteor --production run and make sure Firefox is installed. Then open the Selenium/ folder as a project in Eclipse and run as JUnit 4 tests. All tests should pass on the second run.

###Installation Follow the Meteor Installation Guide. Once meteor is installed, cd into the MeteorApp/ directory and run meteor. The app will be available in your web browser at localhost:3000.

###Unit Tests To run the server side unit tests, set the environment variable JASMINE_SERVER_UNIT=1. For more information check this out

###Note about branches:
"master" is the release branch
"develop" is the default branch for developing that other branches should be branched off from

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages