Skip to content

Commit

Permalink
Update fixture READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cristiano Belloni committed Jan 12, 2023
1 parent ea47860 commit 6bdf317
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 125 deletions.
40 changes: 1 addition & 39 deletions __fixtures__/templates/modular-template-app/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1 @@
# `PackageName__`

This is a [Modular App](https://modular.js.org/package-types/app)

## Build

To [build](https://modular.js.org/commands/build) your app for deployment, run:

```bash
modular build PackageName__
```

The resulting output is an optimized site that can be served statically. All
code (files in `src` plus external dependencies required in the code) is bundled
in a single blob of code that can be split in different files.

## Start

To run your app locally on a development server, run
[start](https://modular.js.org/commands/start):

```bash
modular start PackageName__
```

This causes a developer server to run on port 3000, serving the app with an
additional runtime layer that provides developer experience functionalities like
hot reloading and on-screen error overlay.

## Entry-point

Apps need an entry-point file located at `src/index.tsx`, which typically uses
React to render components to the DOM, generated at `public/index.html`.

## Template

Apps are generated by `modular add` using the
[`modular-template-app`](https://github.com/jpmorganchase/modular/tree/main/packages/modular-template-app)
[template](https://modular.js.org/package-types/template).
# This is a README placeholder for this template fixture
40 changes: 1 addition & 39 deletions __fixtures__/templates/modular-template-filter/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1 @@
# `PackageName__`

This is a [Modular App](https://modular.js.org/package-types/app)

## Build

To [build](https://modular.js.org/commands/build) your app for deployment, run:

```bash
modular build PackageName__
```

The resulting output is an optimized site that can be served statically. All
code (files in `src` plus external dependencies required in the code) is bundled
in a single blob of code that can be split in different files.

## Start

To run your app locally on a development server, run
[start](https://modular.js.org/commands/start):

```bash
modular start PackageName__
```

This causes a developer server to run on port 3000, serving the app with an
additional runtime layer that provides developer experience functionalities like
hot reloading and on-screen error overlay.

## Entry-point

Apps need an entry-point file located at `src/index.tsx`, which typically uses
React to render components to the DOM, generated at `public/index.html`.

## Template

Apps are generated by `modular add` using the
[`modular-template-app`](https://github.com/jpmorganchase/modular/tree/main/packages/modular-template-app)
[template](https://modular.js.org/package-types/template).
# This is a README placeholder for this template fixture
40 changes: 1 addition & 39 deletions __fixtures__/templates/modular-template-no-filter/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1 @@
# `PackageName__`

This is a [Modular App](https://modular.js.org/package-types/app)

## Build

To [build](https://modular.js.org/commands/build) your app for deployment, run:

```bash
modular build PackageName__
```

The resulting output is an optimized site that can be served statically. All
code (files in `src` plus external dependencies required in the code) is bundled
in a single blob of code that can be split in different files.

## Start

To run your app locally on a development server, run
[start](https://modular.js.org/commands/start):

```bash
modular start PackageName__
```

This causes a developer server to run on port 3000, serving the app with an
additional runtime layer that provides developer experience functionalities like
hot reloading and on-screen error overlay.

## Entry-point

Apps need an entry-point file located at `src/index.tsx`, which typically uses
React to render components to the DOM, generated at `public/index.html`.

## Template

Apps are generated by `modular add` using the
[`modular-template-app`](https://github.com/jpmorganchase/modular/tree/main/packages/modular-template-app)
[template](https://modular.js.org/package-types/template).
# This is a README placeholder for this template fixture
6 changes: 3 additions & 3 deletions docs/package-types/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ To run your app locally on a development server, run
modular start my-app-name
```

This causes a developer server to run on port 3000, serving the app with an
additional runtime layer that provides developer experience functionalities like
hot reloading and on-screen error overlay.
This starts a developer server on port 3000, serving the app with an additional
runtime layer that provides developer experience functionalities like hot
reloading and on-screen error overlay.

## Entry-point

Expand Down
2 changes: 1 addition & 1 deletion docs/package-types/esm-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ To run your ESM View locally on a development server, run
modular start my-esm-view-name
```

This causes a developer server to run on port 3000, serving the ESM View with an
This starts a developer server on port 3000, serving the ESM View with an
additional runtime layer that provides a trampoline module to load the generated
files, plus developer experience functionalities like hot reloading and
on-screen error overlay. Please make sure that your ESM View entry-point exports
Expand Down
4 changes: 2 additions & 2 deletions docs/package-types/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ To run your view locally on a development server, run
modular start my-view-name
```

This causes a developer server to run on port 3000, serving the default export
of the View entry-point with an additional runtime layer that provides developer
This starts a developer server on port 3000, serving the default export of the
View entry-point with an additional runtime layer that provides developer
experience functionalities like hot reloading and on-screen error overlay.

## Entry-point
Expand Down
4 changes: 2 additions & 2 deletions packages/modular-scripts/src/__tests__/addPackage.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ describe('When adding a module from a template without a files filter', () => {
).toMatchInlineSnapshot(`
"no-filter-module
├─ CHANGELOG.md
├─ README.md #jm69ih
├─ README.md #13oulez
├─ package.json
├─ public
│ └─ robots.txt #1sjb8b3
Expand Down Expand Up @@ -199,7 +199,7 @@ describe('When adding a module from a template with a files filter', () => {
}),
).toMatchInlineSnapshot(`
"filter-module
├─ README.md #1l66cxg
├─ README.md #13oulez
├─ package.json
├─ src
│ ├─ __tests__
Expand Down

0 comments on commit 6bdf317

Please sign in to comment.