openedx / openedx/frontend-app-authoring
[Editors] Redux/Folder organization
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 218
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 20
Description
Folder structure proposal.
We Currently have this folder structure:
Editors
|-- Containers
| |-- EditorContainer
| | `-- React Components
| |-- ProblemEditor
| | `-- React Components
| |-- TextEditor
| | `-- React Components
| `-- VideoEditor
| `-- React Components
|-- EditorPage
| `-- React Components
`-- Data
|-- Redux
| |-- App
| | |-- Selectors,
| | |-- Reducers,
| | `-- etc
| |-- Problem
| | |-- Selectors,
| | |-- Reducers,
| | `-- etc
| |-- Video
| | |-- Selectors,
| | |-- Reducers,
| | `-- etc
| |-- Requests
| | |-- Selectors,
| | |-- Reducers,
| | `-- etc
| `-- ThunkActions
| |-- App
| |-- Problem
| `-- Video
`-- Services
|-- Api
`-- Urls
This has two problems:
- Where data is dealt with is a hodgepodge of overlapping code
- It does not clearly separate the framework and editor layers of the project.
Therefore, we should have this folder structure:
SRC
|-- Editors
| |-- ProblemEditor
| | |-- Data
| | | |-- Constants
| | | `-- Redux
| | | |-- Selectors
| | | |-- Reducers
| | | |-- Thunkactions
| | | `-- index
| | |-- components
| | `-- index.jsx
| |-- TextEditor
| | |-- Data
| | | |-- Constants
| | | `-- Redux
| | | |-- Selectors
| | | |-- Reducers
| | | |-- Thunkactions
| | | `-- index
| | |-- components
| | `-- index.jsx
| `-- VideoEditor
| |-- Data
| | |-- Constants
| | `-- Redux
| | |-- Selectors
| | |-- Reducers
| | `-- Thunkactions
| |-- components
| `-- index.jsx
`-- Framework
|-- EditorContainer
|-- EditorPage
`-- Data
|-- Constants
|-- Redux
| |-- Selectors
| |-- Reducers
| |-- Thunkactions
| `-- index
`-- Serivces
|-- api
`-- urls
Contributor 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.
Research direction
Review the existing Editors/Containers, Editors/Data/Redux, and Editors/Data/Services areas against the proposed SRC/Editors and Framework layout. Determine the migration boundaries and required import changes, then verify that the resulting organization preserves the existing editor and framework responsibilities.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100