Skip to content

Draft: Move the frontend into its own package #1956

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Draft: Move the frontend into its own package #1956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fb6e49c
git mv binderhub/static/js js/packages/binderhub-frontend/lib
rgaiacs Mar 31, 2025
c1d64a3
Add README for binderhub-frontend
rgaiacs Mar 31, 2025
82bddcc
Add package.json
rgaiacs Mar 31, 2025
e114163
Reduce package.json
rgaiacs Mar 31, 2025
933216b
Relocate webpack configuration
rgaiacs Mar 31, 2025
238086c
Re-write npm run to work with workspaces
rgaiacs Mar 31, 2025
8017c03
Update path in webpack
rgaiacs Mar 31, 2025
902fe81
git mv tsconfig.json js/packages/binderhub-frontend/
rgaiacs Mar 31, 2025
2be9d44
Copy favicon images to npm package
rgaiacs Mar 31, 2025
b59e1ce
Add Usage to README
rgaiacs Mar 31, 2025
5f847e2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 31, 2025
1b54493
After pack JavaScript, copy to binderhub
rgaiacs Apr 25, 2025
0f5dbc0
Add NPM related steps to GitHub action publish
rgaiacs Apr 25, 2025
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
8 changes: 8 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ jobs:
# chartpress requires the full history
fetch-depth: 0

- uses: actions/setup-node@v4
with:
node-version: 20

- uses: actions/setup-python@v5
with:
python-version: "3.12"
Expand All @@ -64,6 +68,10 @@ jobs:
run: |
pip install --no-cache-dir chartpress>=2.1 pyyaml build

- run: npm ci

- run: npm run webpack

- name: Build binderhub wheel
run: python3 -m build --wheel .

Expand Down
39 changes: 39 additions & 0 deletions js/packages/binderhub-frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# `binderhub-frontend`

The default frontend for [BinderHub](https://binderhub.readthedocs.io/).

## Usage

```html
<html>
<head>
<link href="dist/styles.css" rel="stylesheet"></link>
<script>
window.pageConfig = {
"badgeBaseUrl": "https://mybinder.org/",
"baseUrl": "/",
"repoProviders": [
{
"detect": {
"regex": "^(https?://github.com/)?(?\u003crepo\u003e.*[^/])/?"
},
"displayName": "GitHub",
"id": "gh",
"ref": { "default": "HEAD", "enabled": true },
"repo": {
"label": "GitHub repository name or URL",
"placeholder": "example: yuvipanda/requirements or https://github.com/yuvipanda/requirements",
"urlEncode": false
},
"spec": { "validateRegex": "[^/]+/[^/]+/.+" }
}
]
};
</script>
</head>
<body>
<div id="root"></div>
</body>
<script src="dist/bundle.js"></script>
</html>
```
0 binderhub/static/js/App.jsx → js/packages/binderhub-frontend/lib/App.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/App.test.jsx → ...kages/binderhub-frontend/lib/App.test.jsx
View file
Open in desktop
File renamed without changes.
0 .../static/js/components/BuilderLauncher.jsx → ...ontend/lib/components/BuilderLauncher.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/components/ErrorPage.jsx → ...hub-frontend/lib/components/ErrorPage.jsx
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ...b/static/js/components/FaviconUpdater.jsx → ...rontend/lib/components/FaviconUpdater.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import ProgressIcon from "../../images/favicon/progress.ico";
import FailIcon from "../../images/favicon/fail.ico";
import SuccessIcon from "../../images/favicon/success.ico";
import ProgressIcon from "../images/favicon/progress.ico";
import FailIcon from "../images/favicon/fail.ico";
import SuccessIcon from "../images/favicon/success.ico";

import { PROGRESS_STATES } from "./Progress.jsx";

Expand Down
0 ...erhub/static/js/components/HowItWorks.jsx → ...ub-frontend/lib/components/HowItWorks.jsx
View file
Open in desktop
File renamed without changes.
0 ...ub/static/js/components/LinkGenerator.jsx → ...frontend/lib/components/LinkGenerator.jsx
View file
Open in desktop
File renamed without changes.
0 ...static/js/components/LoadingIndicator.css → ...ntend/lib/components/LoadingIndicator.css
View file
Open in desktop
File renamed without changes.
0 ...static/js/components/LoadingIndicator.jsx → ...ntend/lib/components/LoadingIndicator.jsx
View file
Open in desktop
File renamed without changes.
0 ...b/static/js/components/NBViewerIFrame.jsx → ...rontend/lib/components/NBViewerIFrame.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/components/Progress.jsx → ...rhub-frontend/lib/components/Progress.jsx
View file
Open in desktop
File renamed without changes.
Binary file added js/packages/binderhub-frontend/lib/images/favicon/fail.ico
View file
Open in desktop
Binary file not shown.
Binary file added js/packages/binderhub-frontend/lib/images/favicon/progress.ico
View file
Open in desktop
Binary file not shown.
Binary file added js/packages/binderhub-frontend/lib/images/favicon/success.ico
View file
Open in desktop
Binary file not shown.
0 binderhub/static/js/index.d.ts → ...ackages/binderhub-frontend/lib/index.d.ts
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/index.jsx → js/packages/binderhub-frontend/lib/index.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/index.scss → ...ackages/binderhub-frontend/lib/index.scss
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/pages/AboutPage.jsx → ...inderhub-frontend/lib/pages/AboutPage.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/pages/HomePage.jsx → ...binderhub-frontend/lib/pages/HomePage.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/pages/HomePage.test.jsx → ...rhub-frontend/lib/pages/HomePage.test.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/pages/LoadingPage.jsx → ...derhub-frontend/lib/pages/LoadingPage.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/pages/NotFoundPage.jsx → ...erhub-frontend/lib/pages/NotFoundPage.jsx
View file
Open in desktop
File renamed without changes.
0 binderhub/static/js/spec.js → js/packages/binderhub-frontend/lib/spec.js
View file
Open in desktop
File renamed without changes.
94 changes: 94 additions & 0 deletions js/packages/binderhub-frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
{
"name": "binderhub-frontend",
"version": "1.0.0",
"description": "Default frontend for BinderHub",
"dependencies": {
"@fontsource/clear-sans": "^5.0.11",
"bootstrap": "^5.3.3",
"bootstrap-icons": "^1.11.3",
"copy-to-clipboard": "^3.3.3",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"wouter": "^3.3.5",
"@xterm/xterm": "^5.5.0",
"@xterm/addon-fit": "^0.9.0"
},
"devDependencies": {
"@babel/cli": "^7.21.0",
"@babel/core": "^7.21.4",
"@babel/eslint-parser": "^7.22.15",
"@babel/preset-env": "^7.21.4",
"@babel/preset-react": "^7.26.3",
"@types/react": "^19.0.0",
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/react": "^16.1.0",
"@testing-library/user-event": "^14.5.2",
"configurable-http-proxy": "^4.6.2",
"@types/jest": "^29.5.5",
"@whatwg-node/fetch": "^0.9.17",
"autoprefixer": "^10.4.19",
"babel-jest": "^29.7.0",
"babel-loader": "^9.1.2",
"css-loader": "^6.11.0",
"eslint": "^8.38.0",
"eslint-plugin-jest": "^27.4.2",
"eslint-plugin-react": "^7.37.2",
"identity-obj-proxy": "^3.0.0",
"jest": "^29.7.0",
"jest-environment-jsdom": "^29.7.0",
"mini-css-extract-plugin": "^2.7.5",
"postcss-loader": "^8.1.1",
"sass": "^1.77.1",
"sass-loader": "^14.2.1",
"style-loader": "^4.0.0",
"ts-loader": "^9.5.1",
"typescript": "^5.4.5",
"webpack": "^5.78.0",
"webpack-cli": "^5.0.1"
},
"main": "lib/index.jsx",
"directories": {
"lib": "lib"
},
"scripts": {
"webpack": "webpack",
"webpack:watch": "webpack --watch",
"lint": "eslint lib js",
"test": "jest"
},
"jest": {
"testEnvironment": "jsdom",
"collectCoverage": true,
"coverageReporters": [
"text",
"cobertura"
],
"testPathIgnorePatterns": [
"spec.js"
],
"moduleNameMapper": {
"\\.css$": "identity-obj-proxy",
"\\.scss$": "identity-obj-proxy",
"\\.ico$": "identity-obj-proxy"
},
"setupFilesAfterEnv": [
"<rootDir>/setupTests.js"
],
"transformIgnorePatterns": [
"/node_modules/(?!wouter)"
],
"transform": {
"\\.[jt]sx?$": "babel-jest"
}
},
"repository": {
"type": "git",
"url": "git+https://github.com/jupyterhub/binderhub.git"
},
"author": "Project Jupyter Contributors",
"license": "BSD-3-Clause",
"bugs": {
"url": "https://github.com/jupyterhub/binderhub/issues"
},
"homepage": "https://github.com/jupyterhub/binderhub#readme"
}
2 changes: 1 addition & 1 deletion tsconfig.json → js/packages/binderhub-frontend/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@
"moduleResolution": "node",
"sourceMap": true
},
"include": ["binderhub/static/js/"]
"include": ["lib/"]
}
6 changes: 3 additions & 3 deletions webpack.config.js → ...ages/binderhub-frontend/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ const MiniCssExtractPlugin = require("mini-css-extract-plugin");

module.exports = {
mode: "development",
context: path.resolve(__dirname, "binderhub/static"),
entry: "./js/index.jsx",
context: path.resolve(__dirname, "lib"),
entry: "./index.jsx",
output: {
path: path.resolve(__dirname, "binderhub/static/dist/"),
path: path.resolve(__dirname, "dist"),
filename: "bundle.js",
publicPath: "auto",
},
Expand Down
78 changes: 4 additions & 74 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,82 +2,12 @@
"name": "binderhub",
"description": "Frontend Interface for BinderHub",
"private": true,
"dependencies": {
"@fontsource/clear-sans": "^5.0.11",
"bootstrap": "^5.3.3",
"bootstrap-icons": "^1.11.3",
"copy-to-clipboard": "^3.3.3",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"wouter": "^3.3.5",
"@xterm/xterm": "^5.5.0",
"@xterm/addon-fit": "^0.9.0"
},
"devDependencies": {
"@babel/cli": "^7.21.0",
"@babel/core": "^7.21.4",
"@babel/eslint-parser": "^7.22.15",
"@babel/preset-env": "^7.21.4",
"@babel/preset-react": "^7.26.3",
"@types/react": "^19.0.0",
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/react": "^16.1.0",
"@testing-library/user-event": "^14.5.2",
"configurable-http-proxy": "^4.6.2",
"@types/jest": "^29.5.5",
"@whatwg-node/fetch": "^0.9.17",
"autoprefixer": "^10.4.19",
"babel-jest": "^29.7.0",
"babel-loader": "^9.1.2",
"css-loader": "^6.11.0",
"eslint": "^8.38.0",
"eslint-plugin-jest": "^27.4.2",
"eslint-plugin-react": "^7.37.2",
"identity-obj-proxy": "^3.0.0",
"jest": "^29.7.0",
"jest-environment-jsdom": "^29.7.0",
"mini-css-extract-plugin": "^2.7.5",
"postcss-loader": "^8.1.1",
"sass": "^1.77.1",
"sass-loader": "^14.2.1",
"style-loader": "^4.0.0",
"ts-loader": "^9.5.1",
"typescript": "^5.4.5",
"webpack": "^5.78.0",
"webpack-cli": "^5.0.1"
},
"workspaces": [
"js/packages/binderhub-client"
"js/packages/binderhub-client",
"js/packages/binderhub-frontend"
],
"scripts": {
"webpack": "webpack",
"webpack:watch": "webpack --watch",
"lint": "eslint binderhub/static/js js",
"test": "jest"
},
"jest": {
"testEnvironment": "jsdom",
"collectCoverage": true,
"coverageReporters": [
"text",
"cobertura"
],
"testPathIgnorePatterns": [
"spec.js"
],
"moduleNameMapper": {
"\\.css$": "identity-obj-proxy",
"\\.scss$": "identity-obj-proxy",
"\\.ico$": "identity-obj-proxy"
},
"setupFilesAfterEnv": [
"<rootDir>/setupTests.js"
],
"transformIgnorePatterns": [
"/node_modules/(?!wouter)"
],
"transform": {
"\\.[jt]sx?$": "babel-jest"
}
"webpack": "npm run webpack --workspace=js/packages/binderhub-frontend && cp -r js/packages/binderhub-frontend/dist binderhub/static ",
"webpack:watch": "npm run webpack --watch --workspace=js/packages/binderhub-frontend"
}
}
Loading