frontend-app-skills

Please tag @edx/edx-aperture on any PRs or issues.

Introduction

This is a micro-frontend application responsible for displaying and maintaining tools for skills development. This is the home for the B2C Skills Builder.

Installation and Start up

One Time Setup

# Clone the repository
git clone https://github.com/edx/frontend-app-skills.git

# Install requirements and start the development server by running:
cd frontend-app-skills
npm install
npm start

Once the dev server is up visit, http://localhost:1992

Developing in this repo

# Pull the latest code
  git pull

# Make a new branch for your changes
  git checkout -b <your_github_username>/<short_description>

# Clean install/update the dev requirements
  npm ci

# Start the MFE
  npm start

# Make changes in your editor of choice, then run tests and linting
  npm test
  npm run lint

# Commit your changes and push to your branch
  git commit -m "<commit_message>"
  git push

# Open a PR and request review after Github CI has passed

Environment Variables

In order to run the Skills Builder, you'll need to add Algolia keys to the .env.development file. If you have access to the edx-internal repo, you can copy the ones for the Skills MFE's stage configuration. Alternatively, reach out to @edx/edx-aperture.

Project Structure

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

Development Roadmap

• edX Skills Builder - Development Roadmap

Contributions

This repo is not currently accepting contributions.

Reporting Security Issues

Please do not report security issues in public. Please email [email protected].