Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.69 KB

README.rst

File metadata and controls

62 lines (37 loc) · 2.69 KB
Raw

Build Status Codecov license

frontend-template-application

Please tag @edx/fedx-team on any PRs or issues. Thanks.

Introduction

This repository is a template for Open edX micro-frontend applications. It is flagged as a Template Repository, meaning it can be used as a basis for new GitHub repositories by clicking the green "Use this template" button above. The rest of this document describes how to work with your new micro-frontend after you've created a new repository from the template.

After Copying The Template

You'll want to do a find-and-replace to replace all instances of frontend-template-application with the name of your new repository.

Prerequisite

Devstack. If you start Devstack with make dev.up.ecommerce that should give you everything you need as a companion to this frontend.

Installation and Startup

In the following steps, replace "frontend-template-application' with the name of the repo you created when copying this template above.

  1. Clone your new repo:

git clone https://github.com/edx/frontend-template-application.git

  1. Install npm dependencies:

cd frontend-template-application && npm install

  1. Start the dev server:

npm start

The dev server is running at http://localhost:8080.

Project Structure

The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.

Build Process Notes

Production Build

The production build is created with npm run build.

Internationalization

Please see edx/frontend-platform's i18n module for documentation on internationalization. The documentation explains how to use it, and the How To has more detail.