Skip to content

Commit

Permalink
chore: remove outdated readme content
Browse files Browse the repository at this point in the history
  • Loading branch information
coffeeorgreentea committed Aug 6, 2024
1 parent 369bc0e commit 8807807
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 53 deletions.
45 changes: 8 additions & 37 deletions grimoire/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,17 @@
## grimoire

This is currently disonnected from the main monorepo.
I understand that this is not ideal, but its for a solid reason and should be resolved soon.
This repo is import only from the main repo, so you won't break anything by modifying this folder.

Nitro is a bit unique, there are currrently errors we cannot identify without building in the framework.
Therefore this currently builds off of the local verdaccio registry so we can start identifying these places.
It uses the exact same build system/tooling as Nitro so this should be the best starting point.
You'll notice this uses pnpm, this is to leave two options open for us to use in the future:
- continue this as its own repo within the monorepo utilizing pnpm workspaces. We know this will work if this is the case.
- integrate this as an nx package. This is the ideal solution, but nx has some issues with nitro.


## In root of monorepo repo:

```bash
# this will build all tagged packages
npm run build-release
# start the local registry
npx nx run local-registry
# this will publish ALL packages. Expect errors
npm run publish:local
```

## In this folder:
### start playground

```bash
# if you haven't already, Ensure verdaccio is running with the packages published
pnpm install

# this will build everything
pnpm build

# this will run jiti on our main cli (equivalent of a user running npm grimoire dev)
pnpm i
pnpm -r build
pnpm dev
```

# you can also run the CLIs directly
pnpm grimoire dev
pnpm create-grimoire-app

# install the package globally if you want to mess around with it
npm install -g
### run cli in playground

# You can also publish the grimoire package to local registry if you prefer
pnpm release:local
```
pnpm --filter playground grimoire your-command-here
```
38 changes: 22 additions & 16 deletions grimoire/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8807807

Please sign in to comment.