https://github.com/fusky-labs/auburn
A brazen and half-assed attempt at a "web operating system" framework
https://github.com/fusky-labs/auburn
framework lit-element lit-html react react-library
Last synced: 6 months ago
JSON representation
A brazen and half-assed attempt at a "web operating system" framework
- Host: GitHub
- URL: https://github.com/fusky-labs/auburn
- Owner: fusky-labs
- License: apache-2.0
- Created: 2024-12-08T11:56:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-26T06:37:09.000Z (about 1 year ago)
- Last Synced: 2025-04-04T16:34:58.051Z (about 1 year ago)
- Topics: framework, lit-element, lit-html, react, react-library
- Language: TypeScript
- Homepage:
- Size: 244 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Auburn
A "framework" for writing web OSes into your HTML powered by Lit, including React support
## Folder structure
This is a monorepo containing docs written in Astro and its source components handled
by Vite, written in both Lit and React.
- [`docs`](/docs/) - Documentation site
- `packages`
- [`@auburn-core`](/packages/@auburn-core/): The core package
- [`@auburn-react`](/packages/@auburn-react/): React version based from `@auburn-core`
## Setup
Prerequisites:
- Node.js version 21 or higher
- PNPM package manager
Install dependencies with `pnpm install`:
```console
pnpm install
```
### Editing the documentation
Run the `dev:docs` command that is aliased from [`docs`](/docs/)
```console
pnpm run dev:docs
```
## License
Apache-2.0