Skip to content

Commit

Permalink
docs: create non-template README, explain workshop examples
Browse files Browse the repository at this point in the history
  • Loading branch information
brian-smith-tcril authored and Brian Smith committed Mar 21, 2023
1 parent 9fdba71 commit da1c9c2
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 152 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
16.19.1
16
75 changes: 0 additions & 75 deletions README-template-frontend-app.rst

This file was deleted.

38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# frontend-app-workshop-example

## Introduction

This repository contains example Micro-Frontend applications for use during the [Micro-Frontend Micro-Workshop](https://github.com/brian-smith-tcril/mfe-workshop-2023). It has been created using the [`frontend-template-application`](https://github.com/openedx/frontend-template-application) template.

The sample applications are stored in separate branches within this repository and are accompanied by corresponding Pull Requests that offer additional context and information.

| |     Branch     | PR | Description |
| - | - | :---: | - |
| **Hello World** | [`hello-world`](https://github.com/brian-smith-tcril/frontend-app-workshop-example/tree/hello-world) | [![PR Opened](https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/octicons/PullRequestOpened.svg)](https://github.com/brian-smith-tcril/frontend-app-workshop-example/pull/2) | An example "Hello World" page. |
| **Hello Username** | [`hello-username`](https://github.com/brian-smith-tcril/frontend-app-workshop-example/tree/hello-username) | [![PR Opened](https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/octicons/PullRequestOpened.svg)](https://github.com/brian-smith-tcril/frontend-app-workshop-example/pull/3) | Displays the username of the logged-in user. |
| **Simple Paragon Component** | [`simple-paragon`](https://github.com/brian-smith-tcril/frontend-app-workshop-example/tree/simple-paragon) | [![PR Opened](https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/octicons/PullRequestOpened.svg)](https://github.com/brian-smith-tcril/frontend-app-workshop-example/pull/4) | Displays hardcoded test data in a [Paragon Carousel](https://paragon-openedx.netlify.app/components/carousel/) component. |
| **Simple API** | [`simple-api`](https://github.com/brian-smith-tcril/frontend-app-workshop-example/tree/simple-api) | [![PR Opened](https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/octicons/PullRequestOpened.svg)](https://github.com/brian-smith-tcril/frontend-app-workshop-example/pull/5) | Logs course listing data from the API to the console. |
| **API Data in Paragon Component** | [`paragon-api`](https://github.com/brian-smith-tcril/frontend-app-workshop-example/tree/paragon-api) | [![PR Opened](https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/octicons/PullRequestOpened.svg)](https://github.com/brian-smith-tcril/frontend-app-workshop-example/pull/6) | Displays course listing data from the API in a [Paragon Carousel](https://paragon-openedx.netlify.app/components/carousel/) component. |


## Getting Started

### Prerequisites

* [`devstack`](https://github.com/brian-smith-tcril/mfe-workshop-2023#setting-up-devstack)
* [`nvm`](https://github.com/nvm-sh/nvm) (optional but recommended)
* [`node 16`](https://nodejs.dev/en/)

### Running

* Fork this repository

```sh
$ git clone git@github.com:{YOUR_GITHUB_USERNAME}/frontend-app-workshop-example.git
$ cd frontend-app-workshop-example
$ nvm use
$ npm install
$ npm start
```

* Go to http://localhost:8080
76 changes: 0 additions & 76 deletions README.rst

This file was deleted.

0 comments on commit da1c9c2

Please sign in to comment.