/frontend-app-support-tools

Micro-frontend with a series of support tools for edx-platform

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Build Status Codecov |license|

frontend-app-support-tools

Introduction

This repository contains a series of support tools for the OpenedX platform.

Getting Started

Prerequisite

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

Installation and Startup

  1. Clone your new repo:
git clone <Repo URL above>
  1. Install npm dependencies:
cd frontend-app-support-tools && npm install
  1. Start the dev server:
npm start

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

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.