Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 2.55 KB

README.md

File metadata and controls

58 lines (44 loc) · 2.55 KB
Raw

Fun Retro

Easy to use and beautiful restrospective board.

Learn more about retrospectives at funretrospectives.com

Build  devDependency Status

User interface

Fun retro screenshot

How to setup local environment

  1. Clone the repository
  2. Install Node.js
  3. Run npm install (inside the project folder)
  4. Run gulp
  5. Fun Retro is using Firebase. First create an account at firebase. Then create a test app.
  6. Change the Database rules of created app:
{
    "rules": {
        ".read": true,
        ".write": true
    }
}
  1. After creating the app you can save the new url (ex: https://funretrotest.firebaseio.com/) and replace the variable firebaseUrl inside js/firebaseService.js
  2. Now you can open the app on http://localhost:4000/ and start creating your boards. You will notice that the app has this architecture on firebase: Fun retro architecture

Contribute to Fun Retro

  • All things being developed are managed with Github issues.
  • We are currently using labels for Bug and Priority.
    • Please fell free to get any one of those two.
    • Create as many pull requests you want.
  • We also have user recommendations for new features and voting happening at Uservoice

Running the application

  1. Install Node.js
  2. Run npm install (inside the project folder)
  3. Run gulp
  4. Point your browser to http://localhost:4000/ or open dist/index.html

Continuous Integration

Our tests run on SnapCI SnapCI

Running the tests

  1. Run gulp test
  2. Refactor and watch tests re-run.
  3. Fix any red tests
  4. Note: you can open http://localhost:9876/debug.html to run tests with a browser