-
Notifications
You must be signed in to change notification settings - Fork 1
Web Interface Initialization & Jobs Page #95
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.
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
4393207
initialize web interface with basic structure and configuration files
TheArchons dc28df5
add empty pages
TheArchons 3fb6754
add empty pages
TheArchons e85c530
add Navbar component and update routing for profile, machines, jobs, …
TheArchons 05c546c
Merge remote-tracking branch 'origin/web-interface' into web-interface
TheArchons 0ca52f0
add logout functionality and update Navbar links to use React Router
TheArchons 10de839
Remove default pages and components
TheArchons e2f6c76
finished drafting jobs page
notjackl3 4968e02
improved card and navbar
notjackl3 ce01cc9
resized navbar
notjackl3 fc3c61e
Extract JobCard into a generic Card component
TheArchons b51f2fc
Fix: Give the dropdown a background color
TheArchons c480f7b
prettier
TheArchons 3cd1788
Replace GPU chart with a chart of multiple different components. Also…
TheArchons f1da8e6
Update title and manifest for web interface branding
TheArchons 5e13dfc
Refactor button components to a single generic Button with variant su…
TheArchons dbd834d
Refactor Chart into its own component
TheArchons File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "projectName": "web-interface", | ||
| "mode": "file-router", | ||
| "typescript": true, | ||
| "packageManager": "bun", | ||
| "includeExamples": false, | ||
| "tailwind": true, | ||
| "addOnOptions": {}, | ||
| "envVarValues": {}, | ||
| "git": false, | ||
| "routerOnly": true, | ||
| "version": 1, | ||
| "framework": "react", | ||
| "chosenAddOns": [ | ||
| "eslint" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| node_modules | ||
| .DS_Store | ||
| dist | ||
| dist-ssr | ||
| *.local | ||
| .env | ||
| .nitro | ||
| .tanstack | ||
| .wrangler | ||
| .output | ||
| .vinxi | ||
| __unconfig* | ||
| todos.json |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| package-lock.json | ||
| pnpm-lock.yaml | ||
| yarn.lock | ||
TheArchons marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "files.watcherExclude": { | ||
| "**/routeTree.gen.ts": true | ||
| }, | ||
| "search.exclude": { | ||
| "**/routeTree.gen.ts": true | ||
| }, | ||
| "files.readonlyInclude": { | ||
| "**/routeTree.gen.ts": true | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| Welcome to your new TanStack Start app! | ||
|
|
||
| # Getting Started | ||
|
|
||
| To run this application: | ||
|
|
||
| ```bash | ||
| bun install | ||
| bun --bun run dev | ||
| ``` | ||
|
|
||
| # Building For Production | ||
|
|
||
| To build this application for production: | ||
|
|
||
| ```bash | ||
| bun --bun run build | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| This project uses [Vitest](https://vitest.dev/) for testing. You can run the tests with: | ||
|
|
||
| ```bash | ||
| bun --bun run test | ||
| ``` | ||
|
|
||
| ## Styling | ||
|
|
||
| This project uses [Tailwind CSS](https://tailwindcss.com/) for styling. | ||
|
|
||
| ### Removing Tailwind CSS | ||
|
|
||
| If you prefer not to use Tailwind CSS: | ||
|
|
||
| 1. Remove the demo pages in `src/routes/demo/` | ||
| 2. Replace the Tailwind import in `src/styles.css` with your own styles | ||
| 3. Remove `tailwindcss()` from the plugins array in `vite.config.ts` | ||
| 4. Uninstall the packages: `bun install @tailwindcss/vite tailwindcss -D` | ||
|
|
||
| ## Linting & Formatting | ||
|
|
||
|
|
||
| This project uses [eslint](https://eslint.org/) and [prettier](https://prettier.io/) for linting and formatting. Eslint is configured using [tanstack/eslint-config](https://tanstack.com/config/latest/docs/eslint). The following scripts are available: | ||
|
|
||
| ```bash | ||
| bun --bun run lint | ||
| bun --bun run format | ||
| bun --bun run check | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ## Routing | ||
|
|
||
| This project uses [TanStack Router](https://tanstack.com/router) with file-based routing. Routes are managed as files in `src/routes`. | ||
|
|
||
| ### Adding A Route | ||
|
|
||
| To add a new route to your application just add a new file in the `./src/routes` directory. | ||
|
|
||
| TanStack will automatically generate the content of the route file for you. | ||
|
|
||
| Now that you have two routes you can use a `Link` component to navigate between them. | ||
|
|
||
| ### Adding Links | ||
|
|
||
| To use SPA (Single Page Application) navigation you will need to import the `Link` component from `@tanstack/react-router`. | ||
|
|
||
| ```tsx | ||
| import { Link } from "@tanstack/react-router"; | ||
| ``` | ||
|
|
||
| Then anywhere in your JSX you can use it like so: | ||
|
|
||
| ```tsx | ||
| <Link to="/about">About</Link> | ||
| ``` | ||
|
|
||
| This will create a link that will navigate to the `/about` route. | ||
|
|
||
| More information on the `Link` component can be found in the [Link documentation](https://tanstack.com/router/v1/docs/framework/react/api/router/linkComponent). | ||
|
|
||
| ### Using A Layout | ||
|
|
||
| In the File Based Routing setup the layout is located in `src/routes/__root.tsx`. Anything you add to the root route will appear in all the routes. The route content will appear in the JSX where you render `{children}` in the `shellComponent`. | ||
|
|
||
| Here is an example layout that includes a header: | ||
|
|
||
| ```tsx | ||
| import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router' | ||
|
|
||
| export const Route = createRootRoute({ | ||
| head: () => ({ | ||
| meta: [ | ||
| { charSet: 'utf-8' }, | ||
| { name: 'viewport', content: 'width=device-width, initial-scale=1' }, | ||
| { title: 'My App' }, | ||
| ], | ||
| }), | ||
| shellComponent: ({ children }) => ( | ||
| <html lang="en"> | ||
| <head> | ||
| <HeadContent /> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <nav> | ||
| <Link to="/">Home</Link> | ||
| <Link to="/about">About</Link> | ||
| </nav> | ||
| </header> | ||
| {children} | ||
| <Scripts /> | ||
| </body> | ||
| </html> | ||
| ), | ||
| }) | ||
| ``` | ||
|
|
||
| More information on layouts can be found in the [Layouts documentation](https://tanstack.com/router/latest/docs/framework/react/guide/routing-concepts#layouts). | ||
|
|
||
| ## Server Functions | ||
|
|
||
| TanStack Start provides server functions that allow you to write server-side code that seamlessly integrates with your client components. | ||
|
|
||
| ```tsx | ||
| import { createServerFn } from '@tanstack/react-start' | ||
|
|
||
| const getServerTime = createServerFn({ | ||
| method: 'GET', | ||
| }).handler(async () => { | ||
| return new Date().toISOString() | ||
| }) | ||
|
|
||
| // Use in a component | ||
| function MyComponent() { | ||
| const [time, setTime] = useState('') | ||
|
|
||
| useEffect(() => { | ||
| getServerTime().then(setTime) | ||
| }, []) | ||
|
|
||
| return <div>Server time: {time}</div> | ||
| } | ||
| ``` | ||
TheArchons marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## API Routes | ||
|
|
||
| You can create API routes by using the `server` property in your route definitions: | ||
|
|
||
| ```tsx | ||
| import { createFileRoute } from '@tanstack/react-router' | ||
| import { json } from '@tanstack/react-start' | ||
|
|
||
| export const Route = createFileRoute('/api/hello')({ | ||
| server: { | ||
| handlers: { | ||
| GET: () => json({ message: 'Hello, World!' }), | ||
| }, | ||
| }, | ||
| }) | ||
| ``` | ||
|
|
||
| ## Data Fetching | ||
|
|
||
| There are multiple ways to fetch data in your application. You can use TanStack Query to fetch data from a server. But you can also use the `loader` functionality built into TanStack Router to load the data for a route before it's rendered. | ||
|
|
||
| For example: | ||
|
|
||
| ```tsx | ||
| import { createFileRoute } from '@tanstack/react-router' | ||
|
|
||
| export const Route = createFileRoute('/people')({ | ||
| loader: async () => { | ||
| const response = await fetch('https://swapi.dev/api/people') | ||
| return response.json() | ||
| }, | ||
| component: PeopleComponent, | ||
| }) | ||
|
|
||
| function PeopleComponent() { | ||
| const data = Route.useLoaderData() | ||
| return ( | ||
| <ul> | ||
| {data.results.map((person) => ( | ||
| <li key={person.name}>{person.name}</li> | ||
| ))} | ||
| </ul> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| Loaders simplify your data fetching logic dramatically. Check out more information in the [Loader documentation](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#loader-parameters). | ||
|
|
||
| # Demo files | ||
|
|
||
| Files prefixed with `demo` can be safely deleted. They are there to provide a starting point for you to play around with the features you've installed. | ||
|
|
||
| # Learn More | ||
|
|
||
| You can learn more about all of the offerings from TanStack in the [TanStack documentation](https://tanstack.com). | ||
|
|
||
| For TanStack Start specific documentation, visit [TanStack Start](https://tanstack.com/start). | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.