GithubHelp home page GithubHelp logo

isabella232 / pairist Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pivotal-cf/pairist

0.0 0.0 0.0 2.07 MB

Pairing board for the modern era

License: Apache License 2.0

JavaScript 1.01% HTML 0.28% Shell 1.37% TypeScript 96.95% SCSS 0.39%

pairist's Introduction

๐Ÿ‘ฅ Pairist

Pairist is a web app for teams that pair program. It helps you keep track of your pairs and pairing history, the work you have in progress, standup notes, and action items. It can recommend pairs each day based on who has context on what and how recently people have paired with one another.

Pairist v2 is a re-imagining of the Pairist project. The original Pairist can be found on the v1 branch.

โœจ What's new in v2?

Pairist v2 introduces several improvements and changes.

๐Ÿ” You log in as a person, not a team

Pairist v1 only allowed a single username/password for a whole team. In v2, you authenticate as yourself, with your own credentials.

Now that you're logged in as a person, not a team, you can be a member of multiple teams, and you can switch between your teams without logging out.

A team's "people" are now real users who have been added to the team. Team members can be easily added to/removed from teams to better support rotation between teams.

Plus, since you own your own login, you can reset your password! The v1 implementation left us unable to leverage Firebase's password-reset feature.

๐ŸŽจ New & improved UI

The UI has been updated to be more accessible and more mobile-friendly. We moved away from the Material Design-style components in the original Pairist. Still, the interface should be familiar to anyone who used the original.

A few long-standing UI bugs were addressed, especially around text editing for list items and elements getting cut off in smaller browser windows.

โš›๏ธ Rewritten using React, TypeScript, and Cloud Firestore

The original version was written in Vue and plain JavaScript. Though this was working fine, in the spirit of experimentation we decided to migrate to React (for fun) and TypeScript (to benefit from static type-checking). Plus, more people in the Pairist community are familiar with React than with Vue, so we hope this increases maintainability and encourages more contributions.

The back-end previously used Firebase's Realtime Database. Now, we still use Firebase, but we've switched to the newer Cloud Firestore offering. Learn more about the difference.

๐Ÿš€ Deployment

See the deployment doc for detailed instructions.

๐Ÿ’ป Development

You'll need Node, NPM, and Yarn locally. Clone this repo. Check the package.json scripts section for all scripts, but some useful ones are:

  • PAIRIST_FIREBASE_PROJECT_ID=... PAIRIST_FIREBASE_API_KEY=... yarn start to start the front-end locally, using the specified Firebase project as the back-end

  • PAIRIST_FIREBASE_PROJECT_ID=... PAIRIST_FIREBASE_API_KEY=... yarn build to compile the front-end for production, using the specified Firebase project as the back-end

  • yarn test to run unit tests

pairist's People

Contributors

reidmit avatar sweinstein22 avatar dependabot[bot] avatar medoror avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.