Merge pull request #13 from devrnt/docs/playground

Docs/playground

Author: devrnt

.github/workflows/deploy.yml

@@ -0,0 +1,39 @@
+name: Deploy to Github Pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn build:playground
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./playground/dist

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules\\typescript\\lib"
+}

example/components/footer.tsx

@@ -13,6 +13,7 @@
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
+    "build:playground": "yarn --cwd ./playground install && yarn --cwd ./playground build",
     "test": "tsdx test --passWithNoTests",
     "test:watch": "tsdx test --watch",
     "test:coverage": "tsdx test --coverage",

example/components/step.tsx

@@ -0,0 +1,20 @@
+import * as React from 'react';
+
+import { WizardModule } from './modules';
+import { Page, Style } from './modules/common';
+
+const App = () => {
+  return (
+    <>
+      <Style />
+      <Page
+        title="react-use-wizard"
+        description="Playground to showcase the functionalities of react-use-wizard"
+      >
+        <WizardModule />
+      </Page>
+    </>
+  );
+};
+
+export default App;