https://github.com/chromedevtools/performance-stories
Example use cases for performance tooling
https://github.com/chromedevtools/performance-stories
Last synced: about 1 month ago
JSON representation
Example use cases for performance tooling
- Host: GitHub
- URL: https://github.com/chromedevtools/performance-stories
- Owner: ChromeDevTools
- License: bsd-3-clause
- Created: 2022-11-10T10:01:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T11:27:03.000Z (3 months ago)
- Last Synced: 2025-04-15T00:15:54.724Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://chromedevtools.github.io/performance-stories/
- Size: 176 KB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# performance-stories
Example use cases for performance tooling
## Adding a story
Create a new top level folder named based on what it's demonstrating. If you
need to add more context, create a `README.md` file within that folder.
Each story should have an `index.html` file, and can contain any other static
assets that are required.
Run `npm run genindex` afterwards to update the landing page.
## Running a story locally
First, clone the repository and run `npm install`.
You now have two choices:
1. Run `npm run serve`, which will run a server in this repository's root, and
visit `http://localhost:8787/{story-name}/index.html`. For example,
`http://localhost:8787/text-based-lcp/index.html`.
2. Run `npm run serve {story-name}`, which will run a server for that story and
visit `http://localhost:8787` to view that story.
Note: by default the server is only available on `localhost` and not exposed to
the network. You can run `npm run serve-network` to have it exposed to the
network.
## Viewing stories online
This site is automatically deployed via GitHub Pages and available at https://chromedevtools.github.io/performance-stories.