distributed
Fun Retro
Easy to use and beautiful restrospective board.
How to setup local environment
- Clone the repository
- Fun Retro is using Firebase. First create an account at firebase. Then create a test project.
- Enable sign-up using Email/Password for your project. This can be done through the 'Authentication' tab for the project.
- 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);
- 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 - 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
- Install Node.js
- Run
npm install
(inside the project folder) - Install Gulp
- Run
gulp
- 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
- Install Node.js
- Run
npm install
(inside the project folder) - Run
gulp
- Point your browser to http://localhost:4000/ or open dist/index.html
Continuous Integration
Our tests run on TravisCI
Running the tests
- Run
gulp test
- Refactor and watch tests re-run.
- Fix any red tests
- Note: you can open http://localhost:9876/debug.html to run tests with a browser
评论