Mirrors/webring
2
0
Fork 0
mirror of https://github.com/maxboeck/webring synced 2025-02-16 17:58:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

add local development section to README

Browse source
This commit is contained in:
Max Böck 2019-04-15 08:40:56 +02:00
parent bc0c4e83fe
commit 33b987e69c
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -8,6 +8,7 @@ Uses [Eleventy](https://www.11ty.io) and [Netlify](https://www.netlify.com/) to
See the [Demo Site](https://webringdemo.netlify.com)
* Admins manage the ring on Github
* Members are defined in `src/data/members.json`
* Let people add their site through pull request or submit via Netlify Form
* Publish a Code of Conduct
* Provide an embed code that renders a badge (as a web component)
@ -23,3 +24,22 @@ See the [Demo Site](https://webringdemo.netlify.com)
6. After you've set a domain, enter that in `meta.json` as well.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/maxboeck/webring)
## Local Development
To build the site locally, run these commands:
```shell
# clone this repository
git clone git@github.com:maxboeck/webring.git
# go to the working directory
cd webring
# install dependencies
yarn
# start a local build server and the gulp pipeline
yarn start
```