-
Notifications
You must be signed in to change notification settings - Fork 105
Convert Gradebook to frontend-base #500
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
Open
holaontiveros
wants to merge
34
commits into
openedx:frontend-base
Choose a base branch
from
WGU-Open-edX:frontend-base
base: frontend-base
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
f0b6fc2
feat!: add design tokens support (#470)
brian-smith-tcril 42dbbee
chore: update browserslist DB (#480)
edx-requirements-bot a4d1fb2
build(deps): bump dawidd6/action-send-mail from 4 to 6
dependabot[bot] a960814
chore: update browserslist DB (#482)
edx-requirements-bot 427907f
chore: Delete CODEOWNERS (#493)
kdmccormick b88969c
chore: update browserslist DB (#495)
edx-requirements-bot 76104f6
chore: update dependency related things
holaontiveros e58c571
chore: clena gitignore
holaontiveros 6e54e3e
chore: add main ts configs
holaontiveros 03c4142
chore: update main configs related with testing
holaontiveros e33f8f9
chore: update eslint rules
holaontiveros 84dbf6f
chore: remove old webpack config files
holaontiveros 98bb0f8
chore: update i18n related things
holaontiveros 8ac15f3
chore: update getConfig
holaontiveros 23997c6
chore: replace all imports from @edx/frontend-platform and small lint…
holaontiveros 9d29e62
chore: delete .env and add new site.config and related files
holaontiveros ff0ed5c
chore: remove initialization
holaontiveros 0932418
chore: migrate / remove header footer dependencies
holaontiveros 693f0bd
chore: export the modules of your app in your index.ts file
holaontiveros 51408dd
chore: app.scss updates
holaontiveros 5c0c461
chore: remove use of process.env
holaontiveros 8e7386e
chore: convert @import to @use in SCSS files
holaontiveros 1d4fcd3
chore: refactor slots
holaontiveros 6e9af53
chore: remove build from CI
holaontiveros e0d17b9
chore: updated import paths
holaontiveros e8b25b7
chore: update main component for better compatibility (HOC to hooks)
holaontiveros d917612
chore: main renames to match other apps
holaontiveros 6b9dd97
chore: updated fa icons to prevent problems of icons not showing
holaontiveros 4368864
chore: remove undesired features
holaontiveros 3938cd6
chore: small readme updates
holaontiveros f1abed8
chore: fixed comments
holaontiveros 683dba5
chore: comment fixes
holaontiveros 1e13b4d
chore: added right URL for courses menu item
holaontiveros 2572629
chore: fixed eslint config name
holaontiveros File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1 @@ | ||
| coverage/* | ||
| dist/ | ||
| node_modules/ | ||
| src/postcss.config.js | ||
| src/segment.js | ||
| src/lightning.js |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,15 @@ | ||
| .DS_Store | ||
| .eslintcache | ||
| node_modules | ||
| npm-debug.log | ||
| coverage | ||
|
|
||
| module.config.js | ||
| dist/ | ||
| src/i18n/transifex_input.json | ||
| temp/babel-plugin-react-intl | ||
| /*.tgz | ||
|
|
||
| ### pyenv ### | ||
| .python-version | ||
|
|
||
| ### Emacs ### | ||
| *~ | ||
| *.swo | ||
| *.swp | ||
|
|
||
| ### Development environments ### | ||
| .idea | ||
| .vscode | ||
|
|
||
| ### transifex ### | ||
| ### i18n ### | ||
| src/i18n/transifex_input.json | ||
| temp | ||
|
|
||
| src/i18n/messages/ | ||
| ### Editors ### | ||
| .DS_Store | ||
| *~ | ||
| /temp | ||
| /.vscode |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,6 @@ | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Makefile | ||
| npm-debug.log | ||
|
|
||
| config | ||
| coverage | ||
| __mocks__ | ||
| node_modules | ||
| public | ||
| *.test.js | ||
| *.test.jsx | ||
| *.test.ts | ||
| *.test.tsx |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,7 +25,7 @@ For existing documentation see: | |
|
|
||
| ### What does this offer over the legacy gradebook? | ||
|
|
||
| The micro-frontend offers a great deal more granularity when searching for problems, an easy interface for editing grades, an | ||
| The micro-frontend offers a great deal more granularity when searching for problems, an easy interface for editing grades, an | ||
| audit trail for seeing who edited what grade and what reason they gave (if any) for doing so. | ||
|
|
||
| UsageProblems can be filtered by student as in the traditional gradebook, but can also be filtered by scores to see who | ||
|
|
@@ -39,7 +39,7 @@ quick links to the problems for the instructor to visit. It expects the instruct | |
| are grading and which unit they refer to. | ||
|
|
||
| The gradebook is expected to be much more performant for larger numbers of students as well. The Instructor Dashboard | ||
| link for the legacy gradebook reports that "this feature is available only to courses with a small number of enrolled | ||
| link for the legacy gradebook reports that "this feature is available only to courses with a small number of enrolled | ||
| learners." However, this project comes with no such warning. | ||
|
|
||
| ### Who should not change to this gradebook? | ||
|
|
@@ -51,10 +51,10 @@ generated by the current gradebook might find the lack of autogenerated graphs t | |
|
|
||
| ## Getting Started | ||
|
|
||
|
|
||
| ### Installation | ||
|
|
||
| To install gradebook into your project: | ||
|
|
||
| ``` | ||
| npm i --save @edx/frontend-app-gradebook | ||
| ``` | ||
|
|
@@ -97,19 +97,10 @@ Cloning and Startup | |
|
|
||
| To install the project please refer to the [`MFE Development on Tutor`](https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development) instructions. | ||
|
|
||
| When not mounted, gradebook will run in the shared MFE container at http://apps.local.openedx.io/gradebook/course-v1:edX+DemoX+Demo_Course. | ||
| When not mounted, gradebook will run in the shared MFE container at <http://apps.local.openedx.io/gradebook/course-v1:edX+DemoX+Demo_Course>. | ||
|
|
||
| When mounted in the tutor ``gradebook`` container, or when running a local (host) webpack dev server, the web application runs on port **1994**, so when you go to `http://apps.local.openedx.io:1994/gradebook/course-v1:edX+DemoX+Demo_Course` you should see the UI (assuming you have such a Demo Course in your devstack). Note that you always have to provide a course id to actually see a gradebook. | ||
|
|
||
| (Note: This may not work in Tutor; these instructions are for the deprecated Devstack) You can see the log messages for the docker container by executing `make gradebook-logs` in the `devstack` directory. | ||
|
|
||
| Note that starting the container executes the `npm run start` script which will hot-reload JavaScript and Sass files changes, so you should (:crossed_fingers:) not need to do anything (other than wait) when making changes. | ||
|
|
||
| ## Plugins | ||
| This MFE can be customized using [Frontend Plugin Framework](https://github.com/openedx/frontend-plugin-framework). | ||
|
|
||
| The parts of this MFE that can be customized in that manner are documented [here](/src/plugin-slots). | ||
|
|
||
| ## Running tests | ||
|
|
||
| Run: | ||
|
|
@@ -122,21 +113,25 @@ Run: | |
|
|
||
| ## Directory Structure | ||
|
|
||
| * `config` | ||
| * Directory for [`webpack`](https://webpack.js.org/) configurations | ||
| * `public` | ||
| * Entry point for the single-page application - `gradebook` has a single `index.html` file | ||
| * `src` | ||
| * `components` | ||
| * Directory for presentational `React` components | ||
| * `containers` | ||
| * Directory for container `React` components | ||
| * `data` | ||
| * `actions` | ||
| * Directory for `Redux` action creators | ||
| * `constants` | ||
| * `reducers` | ||
| * Directory for `Redux` reducers | ||
| - `config` | ||
| - Directory for [`webpack`](https://webpack.js.org/) configurations | ||
| - `public` | ||
| - Entry point for the single-page application - `gradebook` has a single `index.html` file | ||
| - `src` | ||
| - `components` | ||
| - Directory for presentational `React` components | ||
| - `containers` | ||
| - Directory for container `React` components | ||
| - `data` | ||
| - `actions` | ||
| - Directory for `Redux` action creators | ||
| - `constants` | ||
| - `reducers` | ||
| - Directory for `Redux` reducers | ||
| - `i18n` | ||
| - Directory for i18n related data | ||
| - `slots` | ||
| - Directory for slots components | ||
|
|
||
| ## Authentication with backend API services | ||
|
|
||
|
|
@@ -164,18 +159,18 @@ Getting Help | |
| =========== | ||
|
|
||
| If you're having trouble, we have discussion forums at | ||
| https://discuss.openedx.org where you can connect with others in the community. | ||
| <https://discuss.openedx.org> where you can connect with others in the community. | ||
|
|
||
| Our real-time conversations are on Slack. You can request a [Slack | ||
| invitation](https://openedx.org/slack), then join our | ||
| invitation](https://openedx.org/slack), then join our | ||
| [community Slack workspace](https://openedx.slack.com/) Because this is a | ||
| frontend repository, the best place to discuss it would be in the | ||
| frontend repository, the best place to discuss it would be in the | ||
| [#wg-frontend channel](https://openedx.slack.com/archives/C04BM6YC7A6). | ||
|
|
||
| For anything non-trivial, the best path is to open an issue in this repository | ||
| with as many details about the issue you are facing as you can provide. | ||
|
|
||
| https://github.com/openedx/frontend-app-gradebook/issues | ||
| <https://github.com/openedx/frontend-app-gradebook/issues> | ||
|
|
||
| For more information about these options, see the [Getting Help](https://openedx.org/community/connect) page. | ||
|
|
||
|
|
@@ -186,4 +181,5 @@ All community members are expected to follow the [Open edX Code of Conduct](http | |
|
|
||
| Reporting Security Issues | ||
| ========================= | ||
| Please do not report security issues in public. Please email [email protected]. | ||
|
|
||
| Please do not report security issues in public. Please email <[email protected]>. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /// <reference types="@openedx/frontend-base" /> | ||
|
|
||
| declare module 'site.config' { | ||
| export default SiteConfig; | ||
| } | ||
|
|
||
| declare module '*.svg' { | ||
| const content: string; | ||
| export default content; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| const { createConfig } = require('@openedx/frontend-build'); | ||
| const { createConfig } = require('@openedx/frontend-base/config'); | ||
|
|
||
| module.exports = createConfig('babel'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.