Skip to content
👍 Easy to use and beautiful restrospective tool
Branch: master
Clone or download
Latest commit 55150a0 Oct 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Issues template Jul 25, 2017
components Change ads code Jun 6, 2018
functions Update package-lock Oct 22, 2018
img Adding about me page Jul 6, 2017
js Merge branch 'master' into refactoring/extract-features-to-constant Oct 19, 2018
stylesheets Fix font size Oct 19, 2018
test Exclude tests from code climate analysis Oct 13, 2018
.codeclimate.yml Exclude tests from code climate analysis Oct 13, 2018
.csscomb.json Add autoprefixer May 2, 2017
.firebaserc Update .firebaserc Jul 22, 2017
.gitignore Adding firebase config to gitignore May 2, 2017
.jshintrc Fix jshint errors Apr 3, 2017
.stylelintrc Update stylelint rule Jul 18, 2017
.travis.yml [#221] Updates node engine compatibility to >=8.6.0 Oct 22, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md May 18, 2017
CONTRIBUTING.md Update CONTRIBUTING.md May 5, 2017
LICENSE Update LICENSE Dec 3, 2017
PRIVACY.MD Update PRIVACY.MD Jul 12, 2017
README.md Update README.md Sep 21, 2018
database.rules.bolt Add database rules Oct 22, 2018
database.rules.json Add database rules Oct 22, 2018
deploy.sh Adds readme to deploy branch. Updates deploy message May 1, 2016
favicon.ico Adding favicon Sep 8, 2015
firebase.json Add files for firebase hosting Jul 12, 2017
gulpfile.js Fix create board issue Oct 22, 2018
index.html Remove analytics from github May 24, 2018
karma.conf.js Mocking services dependent on Firebase in order to fix unit tests Apr 25, 2017
package-lock.json Update package-lock Oct 22, 2018
package.json Update packages Oct 19, 2018

README.md

Fun Retro

Easy to use and beautiful restrospective board.

Learn more about retrospectives at funretrospectives.com

Build  devDependency Status

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. Enable sign-up using Email/Password for your project. This can be done through the 'Authentication' tab for the project.
  4. 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);
  1. The app uses firebase auth and creates a new user when you attempt to create a new board. So, once the app is running, head over to your firebase console Authentication section and enable auth using email & password. After change it should look like this screenshot
  2. 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
  1. Install Node.js
  2. Run npm install (inside the project folder)
  3. Install Gulp
  4. Run gulp
  5. 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
You can’t perform that action at this time.