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

[Epic] Standardize app code and architecture including using React #28

Open
vegetabill opened this issue Sep 12, 2018 · 4 comments
Open

Comments

@vegetabill
Copy link
Collaborator

vegetabill commented Sep 12, 2018

This is more of an epic (and placeholder) but presumably we want the codebase to be easy for others to contribute to and be an educational environment for volunteers and students. Currently, this codebase wouldn't represent best practices for students to reference in interviews etc.

Here are some possible ideas in that vein:

  • Switch the view to render via React components
    • All client state should move inside a root component or something like Redux
  • Move active development back to master vs gh-pages using main for trunk dev
  • Improve contributor readme docs
  • Consume dependencies in a standard way using yarn or npm
@lindes
Copy link
Collaborator

lindes commented Oct 5, 2018

Not sure if this deserves to be its own issue, or if it could fit in with this, but another thought I have is to calculate the content of the "keys" data in shortcuts.json based on the "answer" data -- and generally to use symbolic names for things throughout the code, rather than hard-coded numeric values (except if/when absolutely necessary -- like maybe a one-time mapping between the names and numbers, a la the modifierMap in keymaster.js, but going the other direction and with different names -- though ideally, we'd also avoid duplication of effort there, some way, by building the map for one direction from the map for the other, if possible.)

@vegetabill
Copy link
Collaborator Author

@alodahl this seems like a wishlist item and some of these are already done, e.g. there is now a package.json file. If we still think some of the individual subtasks are feasible and important, I can split them into new issues that someone might actually pick up.

@vegetabill vegetabill changed the title [Post-MVP] Refactor app architecture and codebase layout [Epic] Refactor app architecture and codebase layout Sep 8, 2020
@alodahl
Copy link
Collaborator

alodahl commented Sep 13, 2020

FYI this is not priority, but we can look at it later. In the next few weeks it would be best to get the backend issues ready.

@vegetabill
Copy link
Collaborator Author

Sounds good. I updated the body of this ticket to reflect ideas that were already done or are already separate tickets.

I think the only idea still worth having here is converting view layer to React but IIRC that was an explicit decision not to change. If so, we can just close this or repurpose its title to represent that idea and we can document the reasoning for/against it in case the suggestion is made in the future.

@vegetabill vegetabill changed the title [Epic] Refactor app architecture and codebase layout [Epic] Standardize app code and architecture including using React Sep 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants