GraHms/distributed

Fun Retro

Easy to use and beautiful restrospective board.

 

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);

5. 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
6. 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

7. Install Node.js
8. Run npm install (inside the project folder)
9. Install Gulp
10. Run gulp
11. 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