diff --git a/README.md b/README.md index 0e11f85..6961d27 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,32 @@ # Shopware Design Portal -An instance of the `shopware/developer-documentation-vitepress`, as is `shopware/developer-portal`, dedicated for Designers. +An instance of the `shopware/developer-documentation-vitepress`, as is `shopware/developer-portal`, dedicated for +Designers. ## See + - [https://github.com/vuejs/vitepress](˙vuejs/vitepress˙) - SSR framework for the documentation -- [https://github.com/shopware/developer-documentation-vitepress](˙shopware/developer-documentation-vitepress˙) - Shopware specific config, design and components -- \ No newline at end of file +- [https://github.com/shopware/developer-documentation-vitepress](˙shopware/developer-documentation-vitepress˙) - + Shopware specific config, design and components + +## Develop + +Checkout `shopware-design` repository: + +```bash +cd /www/ +git clone git@github.com:shopware/design-portal.git +cd /www/design-portal +``` + +Install pnpm dependencies: + +```bash +pnpm i +``` + +Run local webserver: + +```bash +pnpm dev +```