https://github.com/lilanga/retro-live
Live retrospectives https://www.retrospective.live/
https://github.com/lilanga/retro-live
firebase reactjs realtime-messaging
Last synced: 3 months ago
JSON representation
Live retrospectives https://www.retrospective.live/
- Host: GitHub
- URL: https://github.com/lilanga/retro-live
- Owner: Lilanga
- License: mit
- Created: 2019-12-23T08:51:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-23T09:48:35.000Z (over 5 years ago)
- Last Synced: 2025-01-26T10:41:30.503Z (5 months ago)
- Topics: firebase, reactjs, realtime-messaging
- Language: JavaScript
- Homepage:
- Size: 343 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Retro Live
Easy to use and beautiful restrospective board.
## How to setup local environment
1. Clone the repository
2. Fun Retro is using [Firebase](http://www.firebase.com). 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.
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](https://nodejs.org/en/)
8. Run `npm install` (inside the project folder)
9. Install [Gulp](http://gulpjs.com/)
10. Run `gulp`
11. Now you can open the app on [http://localhost:4000/](http://localhost:4000/) and start creating your boards.
## Contribute to Retro Live
Take a look on our [Contributing](https://github.com/Lilanga/retro/blob/master/CONTRIBUTING.md) guide
## Running the application
1. Install [Node.js](https://nodejs.org/en/)
2. Run `npm install` (inside the project folder)
3. Run `gulp`
4. Point your browser to [http://localhost:4000/](http://localhost:4000/) or open dist/index.html
## Continuous Integration
Our tests run on [TravisCI](https://travis-ci.org/Lilanga/retro)
## 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](http://localhost:9876/debug.html) to run tests with a browser