learningequality / learningequality/studio

Consistent /frontend directory structure

Open
#1,924 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

TAG: tech update / debt
Dominant language
Python
Stars
191
Forks
307
Avg merge
5d 6h
Merged PRs (30d)
10

Description

Summary

We agreed on the directory structure described here (/pages, /components, /layouts).

Most of the components still live in /views.

After all larger pages are merged into vue-refactor we should move it all. That should happen before we merge vue-refactor to develop to start with clean history.

For more details regarding components organization within /components and /pages, see this conversation - would be good to highlight some of the important points here in the scope of this issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/architecture.md and the linked organization discussion, then inspect the /views, /pages, /components, and /layouts directories on vue-refactor. Done means the frontend components follow the agreed directory structure and the architecture documentation highlights the important organization points before vue-refactor merges into develop.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.