{"id":20037747,"url":"https://github.com/openedx/frontend-app-learner-portal-programs","last_synced_at":"2025-07-27T05:38:55.415Z","repository":{"id":36980594,"uuid":"177596265","full_name":"openedx/frontend-app-learner-portal-programs","owner":"openedx","description":"The learner portal allows a customized experience of learner-facing micro-frontend page components.","archived":false,"fork":false,"pushed_at":"2024-11-04T10:07:37.000Z","size":7712,"stargazers_count":6,"open_issues_count":27,"forks_count":8,"subscribers_count":71,"default_branch":"master","last_synced_at":"2024-11-04T11:19:43.877Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-25T13:52:40.000Z","updated_at":"2024-11-04T07:37:16.000Z","dependencies_parsed_at":"2023-10-03T12:49:28.431Z","dependency_job_id":"6bda4809-45fa-46ac-9eda-9c010e74acc0","html_url":"https://github.com/openedx/frontend-app-learner-portal-programs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-portal-programs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-portal-programs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-portal-programs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-portal-programs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-learner-portal-programs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224428785,"owners_count":17309585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T10:21:44.796Z","updated_at":"2024-11-13T10:21:45.435Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# frontend-app-learner-portal-programs\n\n# Purpose\nThe edX learning platform's frontend for program-affiliated learners.\n\n# Getting started\n\n## Requirements for all methods\n\n- OpenedX Docker Devstack up and running for Authentication\n- Clone this repository locally with `git clone \u003crepo URL\u003e`\n\n### With Docker\n\n1. Run `make build`\n2. Run `make up`\n3. Access the local server at `http://localhost:8734`\n\n### Without Docker\n\n##### How to set up the dev environment\nTo run the project, first install dependencies\n\n`$ npm i`\n\nthen, start the dev server:\n\n`$ npm start`\n\n## Where is it running?\nThe project itself will run on  `http://localhost:8734`\n\nyou can test your graphql queries with the playground, found here:  `http://localhost:8734/___graphql`\n\n### How to run/serve a production build locally\n\n```\nnpm run build   # Builds to dist folder\nrm -rf public   # If you already have a public folder there\nmv dist public  # Rename dist folder\nnpm run serve   # Run server. This command will automatically look at public/ directory\n```\n\n## Testing\n\nTesting is supported with Jest and Enzyme. To run tests, use:\n\n`npm test`\n\nto use mock branding data, add `USE_MOCK_DATA` to the `.env.development` file\n\n```\n...\nDESIGNER_BASE_URL='http://localhost:18808'\nHOSTNAME='example.com'\nUNBRANDED_LANDING_PAGE=''\nUSE_MOCK_DATA='true'\n\n```\n\n`.env` forces all variables to be strings, so in order to turn the mock data off again, set `USE_MOCK_DATA` to either an empty string, or delete the variable.\n\n## Other useful commands\n\n`$ npm clean`\n\nThis will remove the current gatsby cache and public folder. Can be useful if you run into plugin/dependency issues, or a graphql error that doesn't make sense.\n\n`$ npm shell`\n\nThis can be used to get into the gatsby instance and see important information, such as the babel config, your static queries, the graphql schema, etc.\n\n\n## License\n\nThe code in this repository is licensed under the AGPLv3 unless otherwise\nnoted.\n\nPlease see `LICENSE \u003cLICENSE\u003e`_ for details.\n\n## Contributing\n\nContributions are very welcome.  Please read `How To Contribute`_ for details.\n\n.. _How To Contribute: https://openedx.org/r/how-to-contribute\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features.  However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\n## Getting Help\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.  Because this is a\nfrontend repository, the best place to discuss it would be in the `#wg-frontend\nchannel`_.\n\nFor anything non-trivial, the best path is to open an issue in this repository\nwith as many details about the issue you are facing as you can provide.\n\nhttps://github.com/openedx/frontend-app-learner-portal-programs/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6\n.. _Getting Help: https://openedx.org/community/connect\n\n##  The Open edX Code of Conduct\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\n## Reporting Security Issues\n\nPlease do not report security issues in public. Please email security@openedx.org.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-learner-portal-programs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-learner-portal-programs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-learner-portal-programs/lists"}