Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Great Client Rewrite #424

Open
8 tasks
ethanwu10 opened this issue Jul 22, 2020 · 0 comments · May be fixed by #470
Open
8 tasks

The Great Client Rewrite #424

ethanwu10 opened this issue Jul 22, 2020 · 0 comments · May be fixed by #470
Assignees
Labels
refactoring Improve code quality
Milestone

Comments

@ethanwu10
Copy link
Member

ethanwu10 commented Jul 22, 2020

The current client contains a lot of haphazard handling of various things (styling and API errors to name a few). It was decided to do a full rewrite of the client so it is more maintainable and has more idiomatic React (w.r.t. dataflow).

Rewrite goals:

  • TypeScript from the beginning
  • theme-ui
  • Custom Webpack config so we don't need to fight preact-cli
  • Hooks for all interactions with API (using swr)
  • react-router v6 for proper state associated with history entries
  • All data (such as tokens) have a source of truth somewhere within React (Context)
  • Split components into presentation components (no logic) and functional components (only logic) for ease of testing
  • Use Storybook for developing UI components + Jest snapshot testing (probably via StoryShots?)
@ethanwu10 ethanwu10 added the refactoring Improve code quality label Jul 22, 2020
@ethanwu10 ethanwu10 added this to the v3 milestone Jul 22, 2020
@ethanwu10 ethanwu10 linked a pull request Aug 9, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Improve code quality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants