feat: basic playground UI

.github/workflows/main.yml

@@ -13,8 +13,16 @@ jobs:
         with:
           node-version: '14.x'
 
-      - name: Install deps and build (with cache)
+      - name: Install deps - root (with cache)
         uses: bahmutov/npm-install@v1
+        with:
+          working-directory: client
+
+      - name: Install deps - client (with cache)
+        uses: bahmutov/npm-install@v1
+      - name: Build client
+        run: yarn build
+        working-directory: client
 
       - name: Lint
         run: yarn lint
@@ -37,8 +45,18 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '14.x'
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
+
+      - name: Install deps - root (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Install deps and build - client (with cache)
+        uses: bahmutov/npm-install@v1
+        with:
+          working-directory: client
+      - name: Build client
+        run: yarn build
+        working-directory: client
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.prettierignore

@@ -0,0 +1 @@
+client/build

README.md

@@ -1,13 +1,12 @@
 # Salesforce Commerce Cloud Playground
 
-## API
+## UI
 
-![json-response-route.png](json-response-route.png)
-![json-response-routes.png](json-response-routes.png)
+![playground-ui.png](playground-ui.png)
 
-## Dashboard
+## API
 
-Coming in the future
+![json-response-route.png](json-response-route.png) ![json-response-routes.png](json-response-routes.png)
 
 ## Installation
 
@@ -26,13 +25,13 @@ The playground uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)
 
 ### Configuration options
 
-| Value         | Description                   | Default value               |
-|---------------|-------------------------------|-----------------------------|
-| rootDir       | Root directory of the project | `process.cwd()`             |
-| cartridgesDir | Path to cartridges directory  | `${cwd}/cartridges`         |
-| cartridgePath | Cartridge path                | app_storefront_base         |
-| modulesPath   | Path to modules directory     | `${cwd}/cartridges/modules` |
-| apiPort       | Port to use for API app       | 8080                        |
+| Value | Description | Default value |
+| --- | --- | --- |
+| rootDir | Root directory of the project | `process.cwd()` |
+| cartridgesDir | Path to cartridges directory | `${cwd}/cartridges` |
+| cartridgePath | Cartridge path | app_storefront_base |
+| modulesPath | Path to modules directory | `${cwd}/cartridges/modules` |
+| apiPort | Port to use for API app | 8080 |
 
 ## Usage
 

__tests__/analyzer/ControllersRegistry.test.js → __tests__/server/analyzer/ControllersRegistry.test.js

@@ -1,4 +1,4 @@
-const controllersRegistry = require('../../src/analyzer/ControllersRegistry');
+const controllersRegistry = require('../../../server/src/analyzer/ControllersRegistry');
 
 jest.mock('fs');
 

__tests__/server/Request.test.js → __tests__/server/server/Request.test.js

@@ -1,4 +1,4 @@
-const Request = require('../../src/server/Request');
+const Request = require('../../../server/src/server/Request');
 
 describe('Request', () => {
   const EXPRESS_REQUEST = {

__tests__/server/Response.test.js → __tests__/server/server/Response.test.js

@@ -1,4 +1,4 @@
-const Response = require('../../src/server/Response');
+const Response = require('../../../server/src/server/Response');
 
 describe('Response', () => {
   test('toJson with no calls on response', () => {

__tests__/server/Route.test.js → __tests__/server/server/Route.test.js

@@ -1,6 +1,6 @@
-const Route = require('../../src/server/Route');
-const Request = require('../../src/server/Request');
-const Response = require('../../src/server/Response');
+const Route = require('../../../server/src/server/Route');
+const Request = require('../../../server/src/server/Request');
+const Response = require('../../../server/src/server/Response');
 
 describe('Route', () => {
   test('getRoute', () => {

__tests__/server/Server.test.js → __tests__/server/server/Server.test.js

@@ -1,4 +1,4 @@
-const server = require('../../src/server/Server');
+const server = require('../../../server/src/server/Server');
 
 describe('Server', () => {
   beforeEach(() => {

bin/sfcc-playground.js

@@ -8,4 +8,4 @@ if (arg === '-v' || arg === '--version') {
   return;
 }
 
-require('../src/app').run();
+require('../server/src/app').run();

client/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

client/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

client/package.json

@@ -0,0 +1,51 @@
+{
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^13.2.0",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/jest": "^27.5.1",
+    "@types/node": "^16.11.36",
+    "@types/react": "^18.0.9",
+    "@types/react-dom": "^18.0.4",
+    "bootstrap": "^5.1.3",
+    "jquery": "^3.6.0",
+    "metismenu": "^3.0.7",
+    "react": "^18.1.0",
+    "react-bootstrap": "^2.4.0",
+    "react-dom": "^18.1.0",
+    "react-json-pretty": "^2.2.0",
+    "react-router-dom": "6",
+    "react-scripts": "5.0.1",
+    "typescript": "^4.6.4",
+    "web-vitals": "^2.1.4"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "CI=false react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@types/bootstrap": "^5.1.11"
+  },
+  "proxy": "http://localhost:8080"
+}

client/public/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Salesforce Playground UI" />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>Salesforce Playground</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

client/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

client/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

client/src/App.tsx

@@ -0,0 +1,21 @@
+import React from 'react';
+import Layout from './components/Layout';
+import PlaygroundContextProvider from './components/PlaygroundContext';
+import { Route, Routes } from 'react-router-dom';
+import { HomePage } from './pages/HomePage';
+import { RoutePage } from './pages/RoutePage';
+
+function App() {
+  return (
+    <PlaygroundContextProvider>
+      <Layout>
+        <Routes>
+          <Route path="/" element={<HomePage />} />
+          <Route path="/route/:route" element={<RoutePage />} />
+        </Routes>
+      </Layout>
+    </PlaygroundContextProvider>
+  );
+}
+
+export default App;

client/src/components/Header.css

@@ -0,0 +1,34 @@
+.app-header {
+  top: 0;
+  width: 100%;
+  background: #fafbfc;
+  align-content: center;
+  align-items: center;
+  display: flex;
+  height: 60px;
+  position: fixed;
+  transition: all 0.2s;
+  z-index: 10;
+}
+
+.app-header.header-shadow {
+  box-shadow: 0 0.46875rem 2.1875rem rgba(8, 10, 37, 0.03),
+    0 0.9375rem 1.40625rem rgba(8, 10, 37, 0.03),
+    0 0.25rem 0.53125rem rgba(8, 10, 37, 0.05),
+    0 0.125rem 0.1875rem rgba(8, 10, 37, 0.03);
+}
+
+.app-header__title {
+  align-items: center;
+  display: flex;
+  height: 60px;
+  padding: 0 1.5rem;
+  transition: width 0.2s;
+  font-size: 1.8rem;
+  font-weight: 600;
+  letter-spacing: -1px;
+}
+
+.app-header__title a {
+  color: inherit;
+}

client/src/components/Header.tsx

@@ -0,0 +1,16 @@
+import React from 'react';
+import { Link } from 'react-router-dom';
+
+import './Header.css';
+
+export function Header() {
+  return (
+    <div>
+      <div className="app-header header-shadow">
+        <div className="app-header__title">
+          <Link to="/">Salesforce Playground</Link>
+        </div>
+      </div>
+    </div>
+  );
+}