chore: find replace template string

This commit is contained in:
Thomas Tracy
2021-12-03 12:03:12 -05:00
parent 62bcd459cb
commit 434ba53702
11 changed files with 18 additions and 40 deletions

View File

@@ -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

View File

@@ -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 <https://github.com/edx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.
The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization <https://github.com/edx/frontend-app-communications/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.
Build Process Notes
-------------------
@@ -68,9 +68,9 @@ Internationalization
Please see `edx/frontend-platform's i18n module <https://edx.github.io/frontend-platform/module-Internationalization.html>`_ for documentation on internationalization. The documentation explains how to use it, and the `How To <https://github.com/edx/frontend-i18n/blob/master/docs/how_tos/i18n.rst>`_ 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

2
package-lock.json generated
View File

@@ -1,5 +1,5 @@
{
"name": "@edx/frontend-template-application",
"name": "@edx/frontend-app-communications",
"version": "0.1.0",
"lockfileVersion": 1,
"requires": true,

View File

@@ -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",

View File

@@ -1,10 +0,0 @@
export default function ExamplePage() {
return (
<main>
<div className="container-fluid">
<h1>Example Page</h1>
<p>Hello world!</p>
</div>
</main>
);
}

View File

@@ -1,5 +0,0 @@
describe('example', () => {
it('will pass because it is an example', () => {
});
});

View File

@@ -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 <https://github.com/edx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_. for more detail.

View File

View File

@@ -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(
<AppProvider>
<Header />
<ExamplePage />
<Footer />
</AppProvider>,
document.getElementById('root'),

View File

@@ -3,7 +3,6 @@
@import "@edx/paragon/scss/core/core.scss";
@import "@edx/brand/paragon/overrides.scss";
@import './example/index.scss';
@import "~@edx/frontend-component-header/dist/index";
@import "~@edx/frontend-component-footer/dist/footer";