workshop/README.md
Corey Johnson a41e086d76
Some checks failed
CI / test (pull_request) Has been cancelled
yes
2025-11-07 10:31:37 -08:00

36 lines
1.2 KiB
Markdown

# Workshop Monorepo
We are making a bunch of smaller projects that occasionally rely on each other. So a monorepo makes a lot of sense! It lets us share code, and share dependencies with minimal fuss.
## Ok, I want to add a new project.
- `bun init packages/WHATEVER_YOU_WANT`
- Edit the `package.json` and change the name to `@workshop/WHATEVER_YOU_WANT`
To add one of the existing packages as a dependency, edit the `package.json` and add it to the `dependencies` or `devDependencies` section. For example, if you want to add `@workshop/WHATEVER_YOU_WANT`, you would do:
```json
{
"dependencies": {
"@workshop/WHATEVER_YOU_WANT": "workspace:*"
}
}
```
Then run `bun install` and import it in your code like so:
```javascript
import { something } from "@workshop/WHATEVER_YOU_WANT"
```
## What does corey not love about this?
- I put near-zero effort into naming things.
- I'd prefer the namespace to be shorter, `@workshop` is a bit long.
- There are lots things I don't love about nano-remix, but it works well enough for now.
- The bun tailwind plugin doesn't work with nano-remix yet, but it looks like in a future bun release it will.
## How do I run the tests?
😂😂😂