diff --git a/apps/wing/project-templates/wing/react-vite/backend/broadcaster.w b/apps/wing/project-templates/wing/react-vite/backend/broadcaster.w new file mode 100644 index 00000000000..794f1583d7b --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/backend/broadcaster.w @@ -0,0 +1,37 @@ +bring cloud; +bring websockets; +bring ui; + +pub class Broadcaster { + pub url: str; + server: websockets.WebSocket; + clients: cloud.Bucket; + + new() { + this.server = new websockets.WebSocket(name: "counter_updates") as "counter_updates"; + this.url = this.server.url; + this.clients = new cloud.Bucket(); + + // upon connection, add the client to the list + this.server.onConnect(inflight(id: str): void => { + this.clients.put(id, ""); + }); + + // upon disconnect, remove the client from the list + this.server.onDisconnect(inflight(id: str): void => { + this.clients.delete(id); + }); + + // Custom resource display in Console UI + // hide the websockets server and cloud bucket resources from the Console UI + nodeof(this.server).hidden = true; + nodeof(this.clients).hidden = true; + } + + // send a message to all clients + pub inflight broadcast(messgae: str) { + for id in this.clients.list() { + this.server.sendMessage(id, messgae); + } + } +} diff --git a/apps/wing/project-templates/wing/react-vite/backend/main.w b/apps/wing/project-templates/wing/react-vite/backend/main.w new file mode 100644 index 00000000000..2a86fb86de4 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/backend/main.w @@ -0,0 +1,47 @@ +bring cloud; +bring expect; +bring vite; +bring http; +bring "./broadcaster.w" as broadcaster; + +// Winglang doesn't have a built-in support for __dirname yet, so we use a workaround to get the current directory. +// @see tracking issue: https://github.com/winglang/wing/issues/3736 +class Utils { + extern "utils.js" pub static __dirname(): str; +} + +let myBroadcaster = new broadcaster.Broadcaster() as "Broadcaster"; +let api = new cloud.Api(cors: true); +let counter = new cloud.Counter(); + +let website = new vite.Vite( + root: "{Utils.__dirname()}/../frontend", + publicEnv: { + TITLE: "Wing + Vite + React", + API_URL: api.url, + WS_URL: myBroadcaster.url + } +) as "Vite Website"; + +api.get("/counter", inflight () => { + return { + body: "{counter.peek()}" + }; +}); + +api.post("/counter", inflight () => { + let prev = counter.inc(); + myBroadcaster.broadcast("refresh"); + return { + body: "{prev + 1}" + }; +}); + +test "api counter increment and get" { + log("counter initial value: {counter.peek()}"); + assert(counter.peek() == 0); + http.post(api.url + "/counter"); + let res = http.get(api.url + "/counter"); + log("counter value after increment: {res.body}"); + assert(res.body == "1"); +} diff --git a/apps/wing/project-templates/wing/react-vite/backend/package.json b/apps/wing/project-templates/wing/react-vite/backend/package.json new file mode 100644 index 00000000000..2274cd6cc62 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/backend/package.json @@ -0,0 +1,11 @@ +{ + "name": "my-wing-app", + "version": "0.0.0", + "description": "A description of my Wing application", + "author": "Your Name", + "license": "MIT", + "wing": true, + "dependencies": { + "@winglibs/vite": "^0.1.2" + } +} diff --git a/apps/wing/project-templates/wing/react-vite/backend/utils.js b/apps/wing/project-templates/wing/react-vite/backend/utils.js new file mode 100644 index 00000000000..e89ea1e8cd3 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/backend/utils.js @@ -0,0 +1 @@ +exports.__dirname = () => __dirname; diff --git a/apps/wing/project-templates/wing/react-vite/frontend/.eslintrc.cjs b/apps/wing/project-templates/wing/react-vite/frontend/.eslintrc.cjs new file mode 100644 index 00000000000..d6c95379530 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/.eslintrc.cjs @@ -0,0 +1,18 @@ +module.exports = { + root: true, + env: { browser: true, es2020: true }, + extends: [ + 'eslint:recommended', + 'plugin:@typescript-eslint/recommended', + 'plugin:react-hooks/recommended', + ], + ignorePatterns: ['dist', '.eslintrc.cjs'], + parser: '@typescript-eslint/parser', + plugins: ['react-refresh'], + rules: { + 'react-refresh/only-export-components': [ + 'warn', + { allowConstantExport: true }, + ], + }, +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/.gitignore b/apps/wing/project-templates/wing/react-vite/frontend/.gitignore new file mode 100644 index 00000000000..a547bf36d8d --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/.gitignore @@ -0,0 +1,24 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +node_modules +dist +dist-ssr +*.local + +# Editor directories and files +.vscode/* +!.vscode/extensions.json +.idea +.DS_Store +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? diff --git a/apps/wing/project-templates/wing/react-vite/frontend/README.md b/apps/wing/project-templates/wing/react-vite/frontend/README.md new file mode 100644 index 00000000000..0d6babeddbd --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/README.md @@ -0,0 +1,30 @@ +# React + TypeScript + Vite + +This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. + +Currently, two official plugins are available: + +- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh +- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh + +## Expanding the ESLint configuration + +If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: + +- Configure the top-level `parserOptions` property like this: + +```js +export default { + // other rules... + parserOptions: { + ecmaVersion: 'latest', + sourceType: 'module', + project: ['./tsconfig.json', './tsconfig.node.json'], + tsconfigRootDir: __dirname, + }, +} +``` + +- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` +- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` +- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list diff --git a/apps/wing/project-templates/wing/react-vite/frontend/index.html b/apps/wing/project-templates/wing/react-vite/frontend/index.html new file mode 100644 index 00000000000..e4b78eae123 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/index.html @@ -0,0 +1,13 @@ + + + + + + + Vite + React + TS + + +
+ + + diff --git a/apps/wing/project-templates/wing/react-vite/frontend/package.json b/apps/wing/project-templates/wing/react-vite/frontend/package.json new file mode 100644 index 00000000000..7ee69d28788 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/package.json @@ -0,0 +1,29 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build": "tsc && vite build", + "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0", + "preview": "vite preview" + }, + "dependencies": { + "react": "^18.2.0", + "react-dom": "^18.2.0", + "react-use-websocket": "^4.7.0" + }, + "devDependencies": { + "@types/react": "^18.2.56", + "@types/react-dom": "^18.2.19", + "@typescript-eslint/eslint-plugin": "^7.0.2", + "@typescript-eslint/parser": "^7.0.2", + "@vitejs/plugin-react": "^4.2.1", + "eslint": "^8.56.0", + "eslint-plugin-react-hooks": "^4.6.0", + "eslint-plugin-react-refresh": "^0.4.5", + "typescript": "^5.2.2", + "vite": "^5.1.4" + } +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/public/vite.svg b/apps/wing/project-templates/wing/react-vite/frontend/public/vite.svg new file mode 100644 index 00000000000..e7b8dfb1b2a --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/public/vite.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/App.css b/apps/wing/project-templates/wing/react-vite/frontend/src/App.css new file mode 100644 index 00000000000..b9d355df2a5 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/App.css @@ -0,0 +1,42 @@ +#root { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; + transition: filter 300ms; +} +.logo:hover { + filter: drop-shadow(0 0 2em #646cffaa); +} +.logo.react:hover { + filter: drop-shadow(0 0 2em #61dafbaa); +} + +@keyframes logo-spin { + from { + transform: rotate(0deg); + } + to { + transform: rotate(360deg); + } +} + +@media (prefers-reduced-motion: no-preference) { + a:nth-of-type(2) .logo { + animation: logo-spin infinite 20s linear; + } +} + +.card { + padding: 2em; +} + +.read-the-docs { + color: #888; +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/App.tsx b/apps/wing/project-templates/wing/react-vite/frontend/src/App.tsx new file mode 100644 index 00000000000..8d1132d6dcd --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/App.tsx @@ -0,0 +1,59 @@ +import { useState, useEffect } from 'react' +import reactLogo from './assets/react.svg' +import viteLogo from '/vite.svg' +import './App.css' +import useWebSocket from 'react-use-websocket'; + +const API_URL = window.wing.env.API_URL; +const WS_URL = window.wing.env.WS_URL; + +function App() { + const [count, setCount] = useState("0"); + const incrementCount = async () => { + const response = await fetch(`${API_URL}/counter`, { + method: "POST" + }); + setCount(await response.text()); + } + const updateCount = async () => { + const response = await fetch(`${API_URL}/counter`); + setCount(await response.text()); + } + + useWebSocket(WS_URL, { + onMessage: () => { + updateCount(); + } + }); + + useEffect(() => { + updateCount(); + }, []); + + return ( + <> +
+ + Vite logo + + + React logo + +
+

{window.wing.env.TITLE}

+
+ +

+ Edit src/App.tsx and save to test HMR +

+
+

+ Click on the Vite and React logos to learn more +

+ + ) +} + +export default App; diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/assets/react.svg b/apps/wing/project-templates/wing/react-vite/frontend/src/assets/react.svg new file mode 100644 index 00000000000..6c87de9bb33 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/assets/react.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/index.css b/apps/wing/project-templates/wing/react-vite/frontend/src/index.css new file mode 100644 index 00000000000..6119ad9a8fa --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/index.css @@ -0,0 +1,68 @@ +:root { + font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif; + line-height: 1.5; + font-weight: 400; + + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: #242424; + + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} +a:hover { + color: #535bf2; +} + +body { + margin: 0; + display: flex; + place-items: center; + min-width: 320px; + min-height: 100vh; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +button { + border-radius: 8px; + border: 1px solid transparent; + padding: 0.6em 1.2em; + font-size: 1em; + font-weight: 500; + font-family: inherit; + background-color: #1a1a1a; + cursor: pointer; + transition: border-color 0.25s; +} +button:hover { + border-color: #646cff; +} +button:focus, +button:focus-visible { + outline: 4px auto -webkit-focus-ring-color; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + a:hover { + color: #747bff; + } + button { + background-color: #f9f9f9; + } +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/main.tsx b/apps/wing/project-templates/wing/react-vite/frontend/src/main.tsx new file mode 100644 index 00000000000..3d7150da80e --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/main.tsx @@ -0,0 +1,10 @@ +import React from 'react' +import ReactDOM from 'react-dom/client' +import App from './App.tsx' +import './index.css' + +ReactDOM.createRoot(document.getElementById('root')!).render( + + + , +) diff --git a/apps/wing/project-templates/wing/react-vite/frontend/src/vite-env.d.ts b/apps/wing/project-templates/wing/react-vite/frontend/src/vite-env.d.ts new file mode 100644 index 00000000000..11f02fe2a00 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.json b/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.json new file mode 100644 index 00000000000..a7fc6fbf23d --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.json @@ -0,0 +1,25 @@ +{ + "compilerOptions": { + "target": "ES2020", + "useDefineForClassFields": true, + "lib": ["ES2020", "DOM", "DOM.Iterable"], + "module": "ESNext", + "skipLibCheck": true, + + /* Bundler mode */ + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "resolveJsonModule": true, + "isolatedModules": true, + "noEmit": true, + "jsx": "react-jsx", + + /* Linting */ + "strict": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "noFallthroughCasesInSwitch": true + }, + "include": ["src"], + "references": [{ "path": "./tsconfig.node.json" }] +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.node.json b/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.node.json new file mode 100644 index 00000000000..97ede7ee6f2 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/tsconfig.node.json @@ -0,0 +1,11 @@ +{ + "compilerOptions": { + "composite": true, + "skipLibCheck": true, + "module": "ESNext", + "moduleResolution": "bundler", + "allowSyntheticDefaultImports": true, + "strict": true + }, + "include": ["vite.config.ts"] +} diff --git a/apps/wing/project-templates/wing/react-vite/frontend/vite.config.ts b/apps/wing/project-templates/wing/react-vite/frontend/vite.config.ts new file mode 100644 index 00000000000..5a33944a9b4 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/frontend/vite.config.ts @@ -0,0 +1,7 @@ +import { defineConfig } from 'vite' +import react from '@vitejs/plugin-react' + +// https://vitejs.dev/config/ +export default defineConfig({ + plugins: [react()], +}) diff --git a/apps/wing/project-templates/wing/react-vite/package.json b/apps/wing/project-templates/wing/react-vite/package.json new file mode 100644 index 00000000000..3ef81049e77 --- /dev/null +++ b/apps/wing/project-templates/wing/react-vite/package.json @@ -0,0 +1,13 @@ +{ + "name": "my-app", + "version": "0.0.0", + "description": "A description of my application", + "author": "Your Name", + "license": "MIT", + "scripts": { + "postinstall": "(cd backend && npm install) && (cd frontend && npm install)" + }, + "dependencies": { + "@winglibs/websockets": "^0.3.2" + } +}