This repository houses the application code for RemoteRetro, a web app that allows distributed teams to conduct effective Agile retrospectives. It is written in Elixir/Phoenix/React/Redux, and is sponsored by Stride Consulting.
- Roadmap to MVP
- Project Management
- Dev Environment Setup
- Tests
- Code
- Contributing
- Code of Conduct
- Acknowledgements
- License
The MVP aims to provide a collaborative, real-time, facilitator-driven retrospective through the following stages:
- The Retrospective Prime Directive
- frame the retro as a safe, collaborative space
- Idea Generation
- invite ideas (happy, sad, confused) from participants
- Mute Mapping
- participants group ideas into categories without speaking
- Labeling + Voting
- participants vote on categories for discussion and root-cause analysis
- Action Item Generation
- participants generate and assign action items
- Action Item Distribution
- facilitator distributes action items via email to all retro participants
To see the project's current feature pipeline, simply install the wonderful ZenHub Chrome Extension.
- visit ZenHub.io, install the ZenHub Chrome Extension, and authorize when prompted
- Note: this installation assumes you visit zenhub.io using Chrome
- once the extension is installed, you should be able to visit the boards by typing 'b', or, if clicking is more your speed, simply click the "Boards" tab on the repo's homepage
- Install Homebrew
- Note: You'll be prompted to install the command-line developer tools. Do it.
- Install PostgreSQL via Homebrew:
brew install postgresql
# (follow directions supplied by brew output upon successful installation)
createdb
# depending on how you installed postgres, this user may already exist
createuser -s postgres
# make sure you can log in to default database
psql -h localhost
- Install the asdf version manager
- Install Erlang, Elixir, and their dependencies by running
bin/install_erlang_and_elixir_with_dependencies - Create the "remote_retro_dev" database and migrate via
mix ecto.create && mix ecto.migrate - Create the "remote_retro_test" database and migrate via
MIX_ENV=test mix ecto.create && mix ecto.migrate
- Ensure you have the asdf version manager installed
- Install the project's Node version and Node dependencies by running
bin/install_node_with_dependencies
Authentication within Remote Retro relies on Google OAuth and the Google+ API. To set this up, navigate to the Google API console and create a new project: https://console.developers.google.com/apis
Next, click on "Credentials" in the left sidebar nav. On the right hand side, click on the "Create Credentials" button and select "OAuth client ID".
Settings
- Application type: Web application
- Authorized JavaScript origins:
http://localhost:4000 - Authorized redirect URIs:
http://localhost:4000/auth/google/callback
Click on the Create button. Using the information Google provides, add the following lines to your profile and source (or open a new terminal).
export REMOTE_RETRO_GOOGLE_OAUTH_CLIENT_ID="<Client Id>"
export REMOTE_RETRO_GOOGLE_OAUTH_CLIENT_SECRET="<Client secret>"
export REMOTE_RETRO_GOOGLE_OAUTH_REDIRECT_URI="http://localhost:4000/auth/google/callback"
Finally, enable the Google+ API for your project.
Start Phoenix endpoint with mix
Now you can visit localhost:4000 from your browser.
To continually execute the backend unit tests on file change:
mix test.watch
To execute the backend unit tests manually:
mix test
To execute the end-to-end tests:
mix e2e
To continually execute the client-side unit tests on file change:
yarn test:watch
To execute the client-side unit tests manually:
yarn test
To run the local eslint:
mix lint
Many thanks to the project's contributors for devoting their time, energy, and passion, and additional thanks go out to the leadership of Stride Consulting for giving this project the opportunity it needed to bloom.