Publishing
To publish your Web Component we recommend netlify.
- It's free
- It's easy
- It provides previews for every PR
- It supports custom domains
Manual Setup
Head over to netlify and register. Select your github account and repository. If you follow these recommendations all you need to do is
- Build command:
npm run site:build - Publish directory:
_site
And you're all set up.
Example
The Set-Game Example has the default publishing via storybook on netlify. You can see the finished page here: https://example-set-game-open-wc.netlify.com/.
Serving With Apache HTTP Server
If you're using our build configuration, the dist directory created by the npm run build command can be deployed on any local web server. These directions are for the Apache HTTP Server specifically, but should be adaptable to other web servers.
- Build command:
npm run build - Copy the
distdirectory to your desired location:sudo cp -R dist /Library/WebServer/Documents/myapp - Add a
<VirtualHost>directive tohttpd.conf, either directly or by anIncludedirective:
<VirtualHost *:80>
DocumentRoot "/Library/WebServer/Documents/myapp"
ServerName mypwa.localhost
Alias "/mypwa" "/Library/WebServer/Documents/myapp"
<Directory "/Library/WebServer/Documents/myapp">
Options -Indexes
AllowOverride None
Require all granted
</Directory>
</VirtualHost>
- Restart Apache:
sudo /usr/sbin/apachectl restart - Open the page in your browser using the URL
http://mypwa.localhost/
If the app was built to support legacy browsers, the dist directory will include the subdirectories legacy and polyfills, and legacy browsers such as Internet Explorer 11 will be served suitable content.