RemoteRetro

Free, world-class retrospectives

Programming language: Elixir

License: MIT License

Tags: Applications    

Latest version: v1.0

README

RemoteRetro

This repository houses the application code for RemoteRetro.org, a free web app that allows distributed teams to conduct Agile retrospectives. It is written in Elixir/Phoenix/React/Redux, and is sponsored by Stride Consulting.

Table of Contents

1. Project Management
2. Dev Environment Setup
3. Tests
4. Code
5. Contributing
6. Code of Conduct
7. Acknowledgements
8. License

Project Management

To see the project's current feature pipeline, simply install the wonderful ZenHub Chrome Extension.

• visit ZenHub.com, install the ZenHub Chrome Extension, and authorize when prompted
  • Note: this installation assumes you visit zenhub.com 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

Dev Environment Setup

PostgreSQL

• 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

Elixir/Phoenix Dependencies

• 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

Node Dependencies

• Ensure you have the asdf version manager installed
• Install the project's Node version and Node dependencies by running bin/install_node_with_dependencies

Google OAuth

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.

And Voila!

Start Phoenix endpoint with mix

Now you can visit localhost:4000 from your browser.

Tests

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

Code

To run the local eslint:

mix lint

Contributing

[Contributing Guidelines](CONTRIBUTING.md)

Code of Conduct

[The Contributor Covenant](CODE_OF_CONDUCT.md)

Acknowledgements

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.

License

[MIT](LICENSE)