openedx / openedx/frontend-build

Consider whether to include public/index.html template as part of @edx/frontend-build

Open
#130 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
25
Forks
41
Avg merge
3d 14h
Merged PRs (30d)
5

Description

This package currently expects the consuming application to have an existing public/index.html template (it will error otherwise).

We may want to explore whether it's possible and/or makes sense to have a default public/index.html template contained within @edx/frontend-build itself so that consuming applications do not need to worry about maintaining their own public/index.html.

However, if an application needs to override a default public/index.html template, it should still be possible to use the public/index.html template from the consuming application.

We should also consider whether this default public/index.html template includes a favicon. For edX microfrontends, the favicon is likely to be the edX logo (eventually pulled from the @edx/brand package), but it likely doesn't make sense to include @edx/brand as a peer dependency of this package, such that @edx/frontend-build remains agnostic.

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

Review how @edx/frontend-build currently expects the consuming application’s public/index.html template and identify the relevant build behavior. Clarify whether a bundled default should exist, how an application override would work, and whether the default should include a favicon or remain independent of @edx/brand.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.