From 434ba53702eb4138aeb96f3b4642ea284f06add7 Mon Sep 17 00:00:00 2001 From: Thomas Tracy Date: Fri, 3 Dec 2021 12:03:12 -0500 Subject: [PATCH] chore: find replace template string --- Makefile | 2 +- README.rst | 24 ++++++++++++------------ package-lock.json | 2 +- package.json | 8 ++++---- src/example/ExamplePage.jsx | 10 ---------- src/example/ExamplePage.test.jsx | 5 ----- src/example/data/.gitkeep | 0 src/example/data/README.rst | 4 ---- src/example/index.scss | 0 src/index.jsx | 2 -- src/index.scss | 1 - 11 files changed, 18 insertions(+), 40 deletions(-) delete mode 100644 src/example/ExamplePage.jsx delete mode 100644 src/example/ExamplePage.test.jsx delete mode 100644 src/example/data/.gitkeep delete mode 100644 src/example/data/README.rst delete mode 100644 src/example/index.scss diff --git a/Makefile b/Makefile index 3377acd..f45b18e 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -transifex_resource = frontend-template-application +transifex_resource = frontend-app-communications transifex_langs = "ar,fr,es_419,zh_CN" transifex_utils = ./node_modules/.bin/transifex-utils.js diff --git a/README.rst b/README.rst index f0d219b..fb6fa6e 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ |Build Status| |Codecov| |license| -frontend-template-application +frontend-app-communications ================================= Please tag **@edx/fedx-team** on any PRs or issues. Thanks. @@ -13,7 +13,7 @@ This repository is a template for Open edX micro-frontend applications. It is fl 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. Also edit index.html to replace "Application Template" with a friendly name for this application that users will see in their browser tab. +You'll want to do a find-and-replace to replace all instances of ``frontend-app-communications`` with the name of your new repository. Also edit index.html to replace "Application Template" with a friendly name for this application that users will see in their browser tab. **Prerequisite** @@ -21,11 +21,11 @@ You'll want to do a find-and-replace to replace all instances of ``frontend-temp **Installation and Startup** -In the following steps, replace "frontend-template-application' with the name of the repo you created when copying this template above. +In the following steps, replace "frontend-app-communications' 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`` + ``git clone https://github.com/edx/frontend-app-communications.git`` 2. Use node v12.x. @@ -33,7 +33,7 @@ In the following steps, replace "frontend-template-application' with the name of 3. Install npm dependencies: - ``cd frontend-template-application && npm install`` + ``cd frontend-app-communications && npm install`` 4. Update the application port to use for local development: @@ -54,7 +54,7 @@ the sections - this helps out all developers understand your MFE, how to install Project Structure ----------------- -The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization `_. +The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization `_. Build Process Notes ------------------- @@ -68,9 +68,9 @@ 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. -.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-template-application.svg?branch=master - :target: https://travis-ci.com/edx/frontend-template-application -.. |Codecov| image:: https://codecov.io/gh/edx/frontend-template-application/branch/master/graph/badge.svg - :target: https://codecov.io/gh/edx/frontend-template-application -.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-template-application.svg - :target: @edx/frontend-template-application +.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-communications.svg?branch=master + :target: https://travis-ci.com/edx/frontend-app-communications +.. |Codecov| image:: https://codecov.io/gh/edx/frontend-app-communications/branch/master/graph/badge.svg + :target: https://codecov.io/gh/edx/frontend-app-communications +.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-communications.svg + :target: @edx/frontend-app-communications diff --git a/package-lock.json b/package-lock.json index 08442c2..fe65bba 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@edx/frontend-template-application", + "name": "@edx/frontend-app-communications", "version": "0.1.0", "lockfileVersion": 1, "requires": true, diff --git a/package.json b/package.json index 21f1ee1..ab0150c 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { - "name": "@edx/frontend-template-application", + "name": "@edx/frontend-app-communications", "version": "0.1.0", "description": "Frontend application template", "repository": { "type": "git", - "url": "git+https://github.com/edx/frontend-template-application.git" + "url": "git+https://github.com/edx/frontend-app-communications.git" }, "browserslist": [ "last 2 versions", @@ -27,12 +27,12 @@ }, "author": "edX", "license": "AGPL-3.0", - "homepage": "https://github.com/edx/frontend-template-application#readme", + "homepage": "https://github.com/edx/frontend-app-communications#readme", "publishConfig": { "access": "public" }, "bugs": { - "url": "https://github.com/edx/frontend-template-application/issues" + "url": "https://github.com/edx/frontend-app-communications/issues" }, "dependencies": { "@edx/brand": "npm:@edx/brand-openedx@1.1.0", diff --git a/src/example/ExamplePage.jsx b/src/example/ExamplePage.jsx deleted file mode 100644 index bdcac7a..0000000 --- a/src/example/ExamplePage.jsx +++ /dev/null @@ -1,10 +0,0 @@ -export default function ExamplePage() { - return ( -
-
-

Example Page

-

Hello world!

-
-
- ); -} diff --git a/src/example/ExamplePage.test.jsx b/src/example/ExamplePage.test.jsx deleted file mode 100644 index 3bad6f3..0000000 --- a/src/example/ExamplePage.test.jsx +++ /dev/null @@ -1,5 +0,0 @@ -describe('example', () => { - it('will pass because it is an example', () => { - - }); -}); diff --git a/src/example/data/.gitkeep b/src/example/data/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/src/example/data/README.rst b/src/example/data/README.rst deleted file mode 100644 index c4db0b6..0000000 --- a/src/example/data/README.rst +++ /dev/null @@ -1,4 +0,0 @@ -data folder -=========== - -This folder is the home for non-component files, such as redux reducers, actions, selectors, API client services, etc. See `Feature-based Application Organization `_. for more detail. \ No newline at end of file diff --git a/src/example/index.scss b/src/example/index.scss deleted file mode 100644 index e69de29..0000000 diff --git a/src/index.jsx b/src/index.jsx index 20ec639..a9a713f 100644 --- a/src/index.jsx +++ b/src/index.jsx @@ -11,7 +11,6 @@ import Header, { messages as headerMessages } from '@edx/frontend-component-head import Footer, { messages as footerMessages } from '@edx/frontend-component-footer'; import appMessages from './i18n'; -import ExamplePage from './example/ExamplePage'; import './index.scss'; @@ -19,7 +18,6 @@ subscribe(APP_READY, () => { ReactDOM.render(
-