Skip to content

Latest commit

 

History

History
executable file
·
57 lines (41 loc) · 3.8 KB

README.md

File metadata and controls

executable file
·
57 lines (41 loc) · 3.8 KB
Raw

Flint Project

Flint is the HTML5 Space Center controls platform. Flint uses Meteor as its core platform.

Prerequisites

The Flint project requires familiarity with the command line on Windows, Mac, or Linux. You will need administrative privileges to run, as well.

If you aren't familliar with what cd or your command line does, then first take the CLI Crashcourse on Learn Code the Hard Way.

Getting Started

  1. Fire up your Terminal
  2. Run curl https://install.meteor.com | sh to install Meteor
  3. Visit NodeJS.org and get the installer for your platform
  4. Run the installer. You now have NodeJS (Which we may need at some point) and NPM (which we need in the next step!)
  5. If you don't already have git, download it from git-scm.org and install it.
  • Find out if you have git by running which git on your command line. If it shows something like /usr/bin/git then you have it!
  1. cd to the directory you'd like to keep Flint and clone it by running git clone https://bitbucket.org/infinitedev/flint.git
  2. To run the project, simply fire up meteor --settings settings.json
  • You may need to create the settings.json file with new keys, based on settings.json.sample
  • Make sure you change the 'audioMatrix' key to false

Contributing

All Javascript code contributions must pass JSHint testing. JSHint automatically tests all code

Unit testing is in development, and will follow the meteor test-packages standard. More documentation on using Tinytest is forthcoming.

Testing

NOTE -- Testing is still in development for Flint and Meteor. The easiest way to get started is to run the following command:

# To test a specific package-name
VELOCITY_TEST_PACKAGES=1 meteor test-packages --driver-package velocity:html-reporter package-name

# To test all packages
VELOCITY_TEST_PACKAGES=1 meteor test-packages --driver-package velocity:html-reporter

(The instructions that don't work yet for unknown reasons): Tests run with the velocity testing framework with jasmine and the html-reporter, the de-facto testing system for Meteor. To get started:

  1. Install Velocity with npm install -g velocity
  2. To test the whole app, run velocity test-app
  3. To test a single package, run velocity test-package package-name
  4. To test all packages, run velocity test-packages

In each case, visit http://localhost:3000 to view the tests.

For more information on testing meteor apps, see https://velocity.readme.io/ and http://www.meteortesting.com/.

Contributor's Agreement

See docs/legal for the official contributors agreement. This document must be signed and returned to Infinite Development Group prior to making contributions to this repository or having pull requests accepted. Contributions to forked repositories without the contributors agreement is allowed.

Legal TLDR

Unless prior arrangements are made, all contributions to this project are completely volunteer and uncompensated. You'll get a pat on the back and a big "thank you", and we'll put your name in CREDITS.md. By contributing, you assign all rights and ownership to any contributions you make to this project to Infinite Development Group, licensed under AGPLv3. You also certify that you are able to do so without conflicting with other agreements (e.g. with employers, etc.).

Licenses & 3rd party software

3rd party software in the project is governed by their respective license. Check out the licenses at the top of the various files for more information on the licenses for various components. All other components are copyright their respective owners, licensed under AGPLv3. See LICENSE.md for specifics.

Flint is Copyright 2013-2016 by Infinite Development Group, LLC. Licensed under AGPLv3. All Rights Reserved Worldwide.