aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2026-03-01 18:18:37 -0800
committerFuwn <[email protected]>2026-03-01 19:28:08 -0800
commitd84732e0d491e89671cd770e495b4c44b35df70d (patch)
tree0171919fd3691b7e7aeb39cbe422af9779d36f1b /README.md
parentci(dx): extract shared node+pnpm setup into composite action (diff)
downloaddue.moe-d84732e0d491e89671cd770e495b4c44b35df70d.tar.xz
due.moe-d84732e0d491e89671cd770e495b4c44b35df70d.zip
chore(monorepo): scaffold workspace layout for apps and shared packages
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 17 insertions, 24 deletions
diff --git a/README.md b/README.md
index 5c91169b..1a96ed9d 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,31 @@
-# create-svelte
+# due.moe
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+This repository now uses a pnpm monorepo workspace layout.
-## Creating a project
+## Structure
-If you're seeing this, you've probably already done this step. Congrats!
+- `.`: The current due.moe app (existing SvelteKit project)
+- `apps/*`: Future-related apps
+- `packages/*`: Shared libraries across apps
+- `packages/shared`: Initial shared workspace package (`@due/shared`)
-```bash
-# create a new project in the current directory
-npm create svelte@latest
+## Install
-# create a new project in my-app
-npm create svelte@latest my-app
+```bash
+pnpm install
```
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+## Current App Commands
```bash
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+pnpm run dev
+pnpm run build
+pnpm run check
+pnpm run lint
```
-## Building
-
-To create a production version of your app:
+## CI-equivalent Local Validation
```bash
-npm run build
+pnpm run check:ci
```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.