README.md

Fun Retro

Easy to use and beautiful restrospective board.

Learn more about retrospectives at funretrospectives.com

Fun retrospective guide at Dummies guide to retrospectives

 

How to setup local environment

1. Clone the repository
2. Fun Retro is using Firebase. First create an account at firebase. Then create a test project.
3. Change the file on js/vendor/firebaseinitialization.js and replace the values with your project values

var config = {
  apiKey: "YOUR_API_KEY",
  authDomain: "YOUR_PROJECT_ID.firebaseapp.com",
  databaseURL: "https://YOUR_PROJECT_ID.firebaseio.com",
  projectId: "YOUR_PROJECT_ID",
  storageBucket: "YOUR_PROJECT_ID.appspot.com",
  messagingSenderId: "YOUR_MESSAGE_ID"
};

firebase.initializeApp(config);

4. If you don't want to file to be tracked by git just run this command on the project home folder:

git update-index --assume-unchanged js/vendor/firebaseInitialization.js

5. Install Node.js
6. Run npm install (inside the project folder)
7. Install Gulp
8. Run gulp
9. Now you can open the app on http://localhost:4000/ and start creating your boards.

Contribute to Fun Retro

Take a look on our Contributing guide

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 TravisCI

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

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]