Skip to content

Commit f7bcfb8

Browse files
committed
fix: replace project-specific README with generic starter kit template
No references to Restock. Describes the architecture, tooling, and AI-powered development workflow for anyone starting a new project.
1 parent 2557a12 commit f7bcfb8

1 file changed

Lines changed: 68 additions & 21 deletions

File tree

readme.md

Lines changed: 68 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,52 @@
1-
# Restock
1+
# Laravel Agentic Starter Kit
22

3-
Intelligent inventory restocking platform for WooCommerce stores. Monitors stock levels, suggests reorder decisions, and automatically updates inventory when orders are received.
3+
A production-ready Laravel starter kit for building AI-powered applications with Inertia.js v3, Vue 3, and Tailwind CSS v4.
44

5-
## Core Workflow
5+
Inspired by [nunomaduro/laravel-starter-kit-inertia-vue](https://github.com/nunomaduro/laravel-starter-kit-inertia-vue), adapted to [BinarCode](https://binarcode.com) standards with DDD architecture, actions pattern, and agentic AI tooling.
66

7-
1. **Monitor** — Syncs with WooCommerce (webhook + polling fallback), tracks stock levels and daily sales velocity
8-
2. **Suggest** — AI calculates reorder urgency, quantities, and revenue-at-risk per product/brand
9-
3. **Order** — Build purchase orders, export as Excel, send to supplier
10-
4. **Confirm** — Upload supplier invoice (PDF/Excel), AI parses and matches to PO, user reviews diff
11-
5. **Receive** — Mark order as received, stock auto-updates in WooCommerce
7+
## What's Included
128

13-
## Tech Stack
9+
- **Laravel 13** with PHP 8.5
10+
- **Inertia.js v3** + **Vue 3** — SPA without SPA complexity
11+
- **Tailwind CSS v4** with shadcn-vue components (reka-ui + CVA + tailwind-merge)
12+
- **Laravel Fortify** — Headless authentication (login, register, password reset, email verification, 2FA)
13+
- **Laravel Wayfinder** — Type-safe route generation for frontend
14+
- **Laravel Boost** — MCP server for AI-assisted development (database queries, docs search, error logs)
15+
- **Pest 5** — Testing with type coverage and browser testing plugins
16+
- **Rector + Pint** — Automated code quality and formatting
17+
- **Larastan** — Static analysis
1418

15-
- **Backend**: Laravel 13, PHP 8.5
16-
- **Frontend**: Inertia.js v3 + Vue 3 + Tailwind CSS v4
17-
- **UI**: reka-ui + CVA + tailwind-merge (shadcn-vue pattern)
18-
- **Auth**: Laravel Fortify
19-
- **MCP**: laravel/mcp
20-
- **Testing**: Pest 5
21-
- **Deployment**: Laravel Forge
19+
## Architecture
20+
21+
This starter follows DDD principles from "Laravel Beyond CRUD" (Spatie):
22+
23+
```
24+
app/
25+
├── Domain/ # Business logic grouped by domain
26+
│ └── {YourDomain}/
27+
│ ├── Actions/ # final readonly classes with __invoke()
28+
│ ├── Data/ # DTOs extending Spatie Laravel Data
29+
│ ├── Models/ # Lean Eloquent models (relationships + casts only)
30+
│ ├── Enums/ # PHP native enums
31+
│ ├── QueryBuilders/
32+
│ └── Events/
33+
├── Http/ # Thin controllers, form requests, middleware
34+
├── Jobs/ # Thin wrappers that call domain actions
35+
└── Console/ # Artisan commands that call domain actions
36+
```
37+
38+
**Key rules:**
39+
- All business logic lives in Actions — never in controllers or models
40+
- Data flows through DTOs — never raw arrays
41+
- Domain code never depends on HTTP — the dependency arrow always points inward
2242

2343
## Getting Started
2444

2545
```bash
46+
# Clone the starter kit
47+
composer create-project binarcode/laravel-agentic-starter-kit my-app
48+
cd my-app
49+
2650
# Install dependencies
2751
composer install
2852
bun install
@@ -38,11 +62,34 @@ composer dev
3862

3963
## Available Commands
4064

41-
- `composer dev` — Start server, queue, logs, and Vite concurrently
42-
- `composer lint` — Run Rector, Pint, and Oxfmt
43-
- `composer test` — Full test suite (type coverage, unit tests, linting, static analysis)
44-
- `composer test:unit` — Pest tests with coverage
65+
| Command | Description |
66+
|---------|-------------|
67+
| `composer dev` | Start server, queue, logs, and Vite concurrently |
68+
| `composer lint` | Run Rector, Pint, and Oxfmt |
69+
| `composer test` | Full test suite (type coverage, unit, linting, static analysis) |
70+
| `composer test:unit` | Pest tests with coverage |
71+
72+
## AI-Powered Development
73+
74+
This starter kit is designed to work with AI coding assistants like Claude Code. It includes:
75+
76+
- **CLAUDE.md** — Project rules and architecture guidelines that AI assistants follow automatically
77+
- **Laravel Boost MCP** — Gives AI assistants access to your database schema, docs, error logs, and more
78+
- **Wayfinder** — Type-safe routes so AI-generated frontend code calls the right endpoints
79+
80+
## Frontend Components
81+
82+
Two-tier component strategy:
83+
84+
1. **`components/ui/`** — shadcn-vue primitives (Button, Card, Dialog, etc.). Managed by the shadcn CLI.
85+
2. **`components/common/`** — Domain-specific components that wrap shadcn primitives into reusable abstractions.
86+
87+
## Credits
88+
89+
- [nunomaduro/laravel-starter-kit-inertia-vue](https://github.com/nunomaduro/laravel-starter-kit-inertia-vue) — Original inspiration
90+
- [Spatie](https://spatie.be) — Laravel Beyond CRUD architecture and coding guidelines
91+
- [BinarCode](https://binarcode.com) — Maintainers
4592

4693
## License
4794

48-
Proprietary — BinarCode SRL
95+
MIT

0 commit comments

Comments
 (0)