Giter VIP home page Giter VIP logo

foss_retro's Introduction

FOSS Retro

This is a simple, real-time agile retrospective board built with Phoenix LiveView and OTP.

Getting Started

This is a Phoenix LiveView project. If you've never worked with Elixir or Phoenix, check out Elixir and Phoenix docs for instructions on how to install the necessary dependences:

If you use asdf for version management, you can also install Elixir via the official plugin.

Recommended Versions

  • Erlang 23.2.7
  • Elixir 1.11.3
  • NodeJS 14.x.x
  • Phoenix 1.5.x

Commands

mix setup

Installs the project's dependences

mix phx.server

Starts the Phoenix server

iex -S mix

Starts an interactive Elixir shell and loads-in the project's code

mix format

Auto-formats your Elixir code

MIX_ENV=test mix test

Runs the project's test suite

foss_retro's People

Contributors

dependabot[bot] avatar h12 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

foss_retro's Issues

Add a character limit to cards and category titles

Problem

Things get weird when you add too many characters to cards and categories.

Suggestions

  • Maybe go with a 280 character limit since that should be familiar to folks.
  • Ecto Changesets might be a good way to do this

Acceptance Criteria

  • Users can not submit cards with more than 280 characters
  • Users can not submit categories with titles long enough to break styling

Add Board timeouts

Problem

As all boards are stored in memory, there needs to be some mechanism for deleting them.

Suggestions

It should be possible to leverage GenServer timeouts to automatically kill BoardSession processes after a specified amount of time.

Acceptance Criteria

  • Board processes automatically kill themselves after one week
  • Users of a board can see how much time is remaining until deletion
  • If a User is viewing a board at the time it is deleted, they should be redirected to the landing page with an alert flash explaining what happened

Fix dependabot audits

Describe the bug
Dependabot caught some some dependency issues in its audit

To Reproduce
Steps to reproduce the behavior:

  1. See banner notification

Expected behavior

  • As few dependabot issues as possible without introducing breaking changes
  • No breaking changes

Add the option to use category templates when creating a new retro-board

Problem

Rather than manually adding categories every time I start a new board, it would be nice to be able to select from a couple of preconfigured templates. It would also be nice to set categories ahead of time, and make them uneditable from the main Board view.

Suggestions

Look up some of the more popular retro formats and add them as templates.

Acceptance Criteria

  • Users have a couple of retro templates to choose from
  • Users can decide whether they want to be able to add new ad-hoc categories on the board screen

Add functionality for exporting Board content

Problem

Exporting content to another format is cumbersome, and required copy-pasting each card individually.

Suggestions

It would be nice to export content from a Board as preformatted text in a couple different styles, like Markdown or Confluence Markup.

Acceptance Criteria

  • Entire board can be copied to clipboard
  • Text formatting supports Markdown
  • Text formatting also supports Confluence Markup

Upgrade to npm 7 and use v2 package-lock files

Problem

The current npm dependencies in assets/ use v1 lockfiles. Upgrade to v2 to take full advantage of npm 7.

Suggestions

N/A

Acceptance Criteria

  • The package-lock.json file is upgraded to v2
  • Using the latest version of npm (at the time of writing, 7.20.6 ) reproduces the same lockfile

Styles are borked after upgrading to phoenix 1.6

Describe the bug
Looks like esbuild doesn't support scss, which means the previous styles aren't being used.

To Reproduce
Steps to reproduce the behavior:

  1. Go to fossretro.com

Expected behavior
Styles not borked.

Additional context
Might be a good opportunity to try tailwind.

Fix horizontal spacing issues

Describe the bug

  • Long strings don't wrap, and increase the column width of each category
  • Colums are kind od squished on narrower viewports

Do something about category creation

At present, anyone can add categories, and no one can remove them.

Figure out whether category spam is a significant issue, and come up with some resolution.

Potential ideas:

  • Make categories removable by the board's creator
  • Make categories only add-able by the creator
  • Create the categories before the board is built, and prevent them from being added in the Live view

Implement CI/CD

Problem

This project is not deployed, and doing it manually is annoying.

Acceptance Criteria

  • There's a deploy branch to which merging will automatically deploy the new code to the internet
  • The code will not deploy if the test suite fails

Add color customizations to cards

Problem

Things look pretty bland right now, and there's no easy way for people to visually indicate which cards are theirs.

Suggestions

A good flow might be for people to be able to select a card color when they join a board for the first time (i.e. when their session is created). Some mechanism to help prevent people from all selecting the same color would also be nice.

Acceptance Criteria

  • There are at least 5 colors folks can select from
  • The contrast ratio between the card background color and the text is consistent, and doesn't sacrifice on legibility (use this tool and target 18:1 <= r < 19:1).

Upgrade to Phoenix 1.6 when it's released

Problem

Phoenix 1.6 will probably be pretty cool, making this app less cool by comparison.

Acceptance Criteria

  • Phoenix 1.6 is used in this project
  • The project still works

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.