Skip to content

docs(install): correct npm source, document peer deps, fix tailwind path #3

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.

Sign up for GitHub

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
maherelgamil merged 1 commit into from
May 28, 2026
Merged

docs(install): correct npm source, document peer deps, fix tailwind path #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ php artisan monorail:install
```

This command will:
- Install the npm package from GitHub Packages
- Install the `monorailphp` npm package from the npm registry
- Update `vite.config.ts` with the Monorail entry point
- Publish the config file
- Publish and run migrations
Expand All @@ -35,6 +35,21 @@ Or install the npm package manually:
npm install monorailphp
```

### Peer dependencies

Starting with `0.2.0`, Monorail's UI libraries (radix-ui, recharts, sonner,
react-day-picker, cmdk, date-fns, lucide-react, class-variance-authority,
clsx, tailwind-merge) are declared as `peerDependencies` so the host app's
versions stay authoritative and React is never duplicated.

- **npm 7+** installs them automatically alongside `monorailphp`.
- **pnpm / yarn with strict peer resolution** require an explicit install:

```bash
npm install radix-ui recharts sonner react-day-picker cmdk date-fns \
lucide-react class-variance-authority clsx tailwind-merge
```

## Manual install

If you prefer not to use the install command, follow these steps:
Expand All @@ -43,7 +58,7 @@ If you prefer not to use the install command, follow these steps:

```css
@import 'tailwindcss';
@source '../../vendor/monorail/monorail/resources/js';
@source '../../node_modules/monorailphp/resources/js';
```

**2. Add the Monorail entry to `vite.config.ts`:**
Expand Down
Loading