Re-organize the project structure to isolate independent functionality and improve clarity
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- full-stack, tooling
Research direction
Start by mapping the current project structure and reading server/repos/controller.ts to understand which functionality belongs together. Compare it with the proposed packages for the UI, API, GitHub App, and Utilities, including the example API files. Done means the project is reorganized into those sub-packages with unclear functionality split into atomic files.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem?
The current project structure can be confusing to navigate and does not make obvious where different sets of functionality are located.
Describe the solution you'd like
We should migrate the project to a monorepo stucture with sub-packages for the UI, API, GitHub App, and Utilities. This should include breaking down files with unclear functionality into atomic files. Ex: server/repos/controller.ts splits into packages/api/repos/listMirrors.ts , packages/api/mirrors/createMirror.ts, etc.
Describe alternatives you've considered
The functionality could be split out into separate repositories instead but that would introduce additional overhead and make it harder to implement cross-component changes.
Additional context
This work should help to enable #120 since the API will be split out into it's own package that can be published separately as part of that work.
- Dominant language
- TypeScript
- Stars
- 203
- Forks
- 42
- Avg merge
- 1h 15m
- Merged PRs (30d)
- 8
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github-community-projects/private-mirrors
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github-community-projects/private-mirrors#525 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
github-community-projects/private-mirrors#524 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-2 days Newbie friendliness 68/100
github-community-projects/private-mirrors#449 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
github-community-projects/private-mirrors#485 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 48/100
github-community-projects/private-mirrors#481 ·
Maintainers usually reply within 1 day
All issues in github-community-projects/private-mirrors
Similar issues
-
no-repo-link tool-submission
Difficulty 1/5 Under an hour Newbie friendliness 66/100
BraveOPotato/NoSignups#2458 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
drmrd/vernacular#1061 ·
Maintainers usually reply within 1 day
-
[Bug] PUT /profiles/{id} silently drops design_prompt — designed voice profiles cannot be editedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
automated issue report
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
eventua11y/eventua11y.com#982 ·
Maintainers usually reply within 1 day