Skip to content

chore: adding start script #1343 #1344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions packages/docs/src/docs/running-patternlab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Running Pattern Lab
tags:
- docs
category: getting-started
eleventyNavigation:
title: Running Pattern Lab
key: getting-started
order: 1
sitemapPriority: '0.8'
sitemapChangefreq: 'monthly'
---

## Running Pattern Lab

It's as easy as running the following command:

```
npm run start
```

This will start the system and open the URL it's running on within your browser.
Relevant information regarding and step and possible errors are being logged to the console so it's recommended to watch out for any problems possibly occuring with your installation or any of the content or data you're setting up.

### Problems and errors after restructuring files and folders

If you're doing bigger changes especially to the file and folder structure and recognize some errors on the console like e.g. `TypeError: Cannot read property 'render' of undefined` or `Error building BuildFooterHTML`, it's recommended to stop Pattern Lab, delete the cache file `dependencyGraph.json` within the projects root and start Pattern Lab again, as these changes might conflict with the existing cache structures.
3 changes: 2 additions & 1 deletion packages/edition-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"pl:help": "patternlab --help",
"pl:install": "patternlab install --config ./patternlab-config.json",
"pl:serve": "patternlab serve --config ./patternlab-config.json",
"pl:version": "patternlab --version"
"pl:version": "patternlab --version",
"start": "npm run pl:serve"
},
"license": "MIT",
"engines": {
Expand Down