Skip to content

feat(apps): scaffold experimentation apps #599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(apps): scaffold experimentation apps #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions apps/dashboard/eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// @ts-check
import baseESLintConfig from '@repo/config-eslint'
import reactConfig from '@repo/config-eslint/react'

export default [
{
ignores: [
'.DS_Store',
'**/node_modules',
'**/build',
'**/dist',
'.env',
'.env.*',
'!.env.example',
],
},
...baseESLintConfig,
...reactConfig,
]
12 changes: 12 additions & 0 deletions apps/dashboard/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
<title>Dashboard</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
32 changes: 32 additions & 0 deletions apps/dashboard/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "@sanity/dashboard",
"version": "0.0.0",
"private": true,
"type": "module",
"scripts": {
"build": "pnpm tsc && vite build",
"clean": "rimraf dist",
"dev": "vite",
"lint": "eslint .",
"preview": "vite preview",
"tsc": "tsc --noEmit"
},
"prettier": "@sanity/prettier-config",
"dependencies": {
"@sanity/sdk-react": "workspace:*",
"@sanity/ui": "^2.15.13",
"react": "^18.3.1",
"react-compiler-runtime": "19.1.0-rc.1",
"react-dom": "^18.3.1",
"typescript": "^5.8.3"
},
"devDependencies": {
"@repo/config-eslint": "workspace:*",
"@repo/tsconfig": "workspace:*",
"@types/react": "^19.1.2",
"@types/react-dom": "^19.1.2",
"@vitejs/plugin-react": "^4.4.1",
"eslint": "^9.25.1",
"vite": "^6.3.4"
}
}
53 changes: 53 additions & 0 deletions apps/dashboard/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import {SanityApp, SanityConfig} from '@sanity/sdk-react'
import {Spinner, ThemeProvider} from '@sanity/ui'
import {buildTheme} from '@sanity/ui/theme'
import {type JSX, Suspense} from 'react'

const theme = buildTheme({})

const devConfigs: SanityConfig[] = [
{
projectId: 'ppsg7ml5',
dataset: 'test',
},
{
projectId: 'd45jg133',
dataset: 'production',
},
{
projectId: 'v28v5k8m',
dataset: 'production',
},
]

export default function App(): JSX.Element {
return (
<ThemeProvider theme={theme}>
<SanityApp fallback={<Spinner />} config={devConfigs}>
<Suspense>
<div
style={{
position: 'fixed',
inset: 0,
display: 'flex',
flexDirection: 'column',
}}
>
<div style={{padding: 12, borderBottom: '1px solid #eee'}}>
Dashboard (iframes sdk-app below)
</div>
<iframe
title="sdk-app"
src="http://localhost:3341/"
style={{
flex: 1,
border: 'none',
width: '100%',
}}
/>
</div>
</Suspense>
</SanityApp>
</ThemeProvider>
)
}
10 changes: 10 additions & 0 deletions apps/dashboard/src/main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import {StrictMode} from 'react'
import {createRoot} from 'react-dom/client'

import App from './App'

createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />
</StrictMode>,
)
18 changes: 18 additions & 0 deletions apps/dashboard/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"extends": "@repo/tsconfig/base.json",
"compilerOptions": {
"rootDir": "../../",
"baseUrl": "../../",
"verbatimModuleSyntax": false,
"noEmit": true,
"module": "ESNext",
"types": ["vite/client"],
"paths": {
"@sanity/sdk": ["./packages/core/src/_exports/index.ts"],
"@sanity/sdk/*": ["./packages/core/src/_exports/*"],
"@sanity/sdk-react": ["./packages/react/src/_exports/index.ts"],
"@sanity/sdk-react/*": ["./packages/react/src/_exports/*"]
}
},
"include": ["**/*.ts", "**/*.tsx"]
}
48 changes: 48 additions & 0 deletions apps/dashboard/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import {resolve} from 'node:path'

import react from '@vitejs/plugin-react'
import {defineConfig, loadEnv} from 'vite'

const ReactCompilerConfig = {
target: '18',
}

export default defineConfig(({mode}) => {
const rootDir = resolve(process.cwd(), '../..')
const env = loadEnv(mode, rootDir, '')

const isE2E = mode === 'e2e'

return {
server: {
port: 3340,
fs: {strict: false},
},
plugins: [
react({
babel: {
plugins: [['babel-plugin-react-compiler', ReactCompilerConfig]],
},
}),
],
clearScreen: false,
resolve: {
alias: {
'@sanity/sdk': resolve(import.meta.dirname, '../../packages/core/src/_exports'),
'@sanity/sdk-react': resolve(import.meta.dirname, '../../packages/react/src/_exports'),
},
},
define: {
'import.meta.env.VITE_IS_E2E': JSON.stringify(isE2E),
'import.meta.env.VITE_E2E_PROJECT_ID': JSON.stringify(
process.env['SDK_E2E_PROJECT_ID'] || env['SDK_E2E_PROJECT_ID'],
),
'import.meta.env.VITE_E2E_DATASET_0': JSON.stringify(
process.env['SDK_E2E_DATASET_0'] || env['SDK_E2E_DATASET_0'],
),
'import.meta.env.VITE_E2E_DATASET_1': JSON.stringify(
process.env['SDK_E2E_DATASET_1'] || env['SDK_E2E_DATASET_1'],
),
},
}
})
2 changes: 1 addition & 1 deletion apps/kitchensink-react/src/AppRoutes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {ProtectedRoute} from './ProtectedRoute'
import {DashboardContextRoute} from './routes/DashboardContextRoute'
import {DashboardWorkspacesRoute} from './routes/DashboardWorkspacesRoute'
import ExperimentalResourceClientRoute from './routes/ExperimentalResourceClientRoute'
import {ProjectsRoute} from './routes/ProjectsRoute'
import {PerspectivesRoute} from './routes/PerspectivesRoute'
import {ProjectsRoute} from './routes/ProjectsRoute'
import {ReleasesRoute} from './routes/releases/ReleasesRoute'
import {UserDetailRoute} from './routes/UserDetailRoute'
import {UsersRoute} from './routes/UsersRoute'
Expand Down
19 changes: 19 additions & 0 deletions apps/sdk-app/eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// @ts-check
import baseESLintConfig from '@repo/config-eslint'
import reactConfig from '@repo/config-eslint/react'

export default [
{
ignores: [
'.DS_Store',
'**/node_modules',
'**/build',
'**/dist',
'.env',
'.env.*',
'!.env.example',
],
},
...baseESLintConfig,
...reactConfig,
]
12 changes: 12 additions & 0 deletions apps/sdk-app/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
<title>SDK App</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
32 changes: 32 additions & 0 deletions apps/sdk-app/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "@sanity/sdk-app",
"version": "0.0.0",
"private": true,
"type": "module",
"scripts": {
"build": "pnpm tsc && vite build",
"clean": "rimraf dist",
"dev": "vite",
"lint": "eslint .",
"preview": "vite preview",
"tsc": "tsc --noEmit"
},
"prettier": "@sanity/prettier-config",
"dependencies": {
"@sanity/sdk-react": "workspace:*",
"@sanity/ui": "^2.15.13",
"react": "^18.3.1",
"react-compiler-runtime": "19.1.0-rc.1",
"react-dom": "^18.3.1",
"typescript": "^5.8.3"
},
"devDependencies": {
"@repo/config-eslint": "workspace:*",
"@repo/tsconfig": "workspace:*",
"@types/react": "^19.1.2",
"@types/react-dom": "^19.1.2",
"@vitejs/plugin-react": "^4.4.1",
"eslint": "^9.25.1",
"vite": "^6.3.4"
}
}
33 changes: 33 additions & 0 deletions apps/sdk-app/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import {SanityApp, SanityConfig} from '@sanity/sdk-react'
import {Spinner, ThemeProvider} from '@sanity/ui'
import {buildTheme} from '@sanity/ui/theme'
import {type JSX, Suspense} from 'react'

const theme = buildTheme({})

const devConfigs: SanityConfig[] = [
{
projectId: 'ppsg7ml5',
dataset: 'test',
},
{
projectId: 'd45jg133',
dataset: 'production',
},
{
projectId: 'v28v5k8m',
dataset: 'production',
},
]

export default function App(): JSX.Element {
return (
<ThemeProvider theme={theme}>
<SanityApp fallback={<Spinner />} config={devConfigs}>
<Suspense>
<div style={{padding: 16}}>SDK app scaffold</div>
</Suspense>
</SanityApp>
</ThemeProvider>
)
}
10 changes: 10 additions & 0 deletions apps/sdk-app/src/main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import {StrictMode} from 'react'
import {createRoot} from 'react-dom/client'

import App from './App'

createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />
</StrictMode>,
)
18 changes: 18 additions & 0 deletions apps/sdk-app/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"extends": "@repo/tsconfig/base.json",
"compilerOptions": {
"rootDir": "../../",
"baseUrl": "../../",
"verbatimModuleSyntax": false,
"noEmit": true,
"module": "ESNext",
"types": ["vite/client"],
"paths": {
"@sanity/sdk": ["./packages/core/src/_exports/index.ts"],
"@sanity/sdk/*": ["./packages/core/src/_exports/*"],
"@sanity/sdk-react": ["./packages/react/src/_exports/index.ts"],
"@sanity/sdk-react/*": ["./packages/react/src/_exports/*"]
}
},
"include": ["**/*.ts", "**/*.tsx"]
}
31 changes: 31 additions & 0 deletions apps/sdk-app/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import {resolve} from 'node:path'

import react from '@vitejs/plugin-react'
import {defineConfig} from 'vite'

const ReactCompilerConfig = {
target: '18',
}

export default defineConfig(() => {
return {
server: {
port: 3341,
fs: {strict: false},
},
plugins: [
react({
babel: {
plugins: [['babel-plugin-react-compiler', ReactCompilerConfig]],
},
}),
],
clearScreen: false,
resolve: {
alias: {
'@sanity/sdk': resolve(import.meta.dirname, '../../packages/core/src/_exports'),
'@sanity/sdk-react': resolve(import.meta.dirname, '../../packages/react/src/_exports'),
},
},
}
})
16 changes: 16 additions & 0 deletions knip.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,22 @@
],
project,
},
'apps/dashboard': {
entry: ['src/main.tsx'],
typescript: {
config: 'tsconfig.json',
},
ignoreDependencies: ['@repo/tsconfig', 'react-compiler-runtime'],
project,
},
'apps/sdk-app': {
entry: ['src/main.tsx'],
typescript: {
config: 'tsconfig.json',
},
ignoreDependencies: ['@repo/tsconfig', 'react-compiler-runtime'],
project,
},
'apps/*': {
typescript: {
config: 'tsconfig.json',
Expand Down Expand Up @@ -64,7 +80,7 @@
entry: ['src/index.ts', 'src/setup/**/*.ts', 'src/teardown/**/*.ts'],
ignoreDependencies: ['@repo/tsconfig'],
},
// TODO: Remove this once we have presence fully implemented in the SDK

Check warning on line 83 in knip.config.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected 'todo' comment: 'TODO: Remove this once we have presence...'
'packages/core': {
typescript: {
config: 'tsconfig.settings.json',
Expand Down
Loading
Loading