Skip to content

Commit 4fc17c7

Browse files
committed
wip
1 parent 39c68f4 commit 4fc17c7

File tree

1 file changed

+17
-74
lines changed

1 file changed

+17
-74
lines changed

README.md

+17-74
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
### tl;dr
1+
### TL;DR
22

33
```bash
44
composer create-project justd/laravel your-project-name
55
```
66

77
## Using NPM
88

9-
when you're using npm, you have to include `--legacy-peer-deps` flag.
9+
If you're using NPM, make sure to include the `--legacy-peer-deps` flag:
1010

1111
```bash
1212
npm i --legacy-peer-deps
@@ -19,92 +19,35 @@ composer run dev
1919
bun i && composer run dev
2020
```
2121

22-
You absolutely need to run the `bun run dev`, because the route is generated and watching while it's in dev.
22+
You must run `bun run dev` to ensure the routes are generated and watched properly during development.
2323

24-
### Laravel Inertia React w/ Typescript
24+
### Laravel Inertia React with TypeScript
2525

26-
By default, if we use package like Laravel breeze, it'll use regular javascript react by default. But this project is
27-
for you who want to use inertia.js with typescript boilerplate.
26+
By default, packages like Laravel Breeze use regular JavaScript for React. However, this project is tailored for those who want an Inertia.js boilerplate with TypeScript.
2827

29-
This project has come with some features like:
28+
#### Features
3029

3130
- Authentication
3231
- User Profile
33-
- User Password
34-
- User Delete
35-
- User Resources (--only=[index, show, edit, update, destroy])
32+
- User Password Management
33+
- User Deletion
34+
- User Resources (`--only=[index, show, edit, update, destroy]`)
3635
- Pagination
3736

3837
### Quick Login
3938

40-
This project has a feature to login quickly. You can use this feature by adding `/dev/login/{user_id}` to the url. For
41-
example: `http://localhost:8000/dev/login/1`. And then you can login as user with id `1`. But this feature only works in
42-
development mode with `APP_ENV=local` in `.env` file. Make sure you have a user with id `1` in your database.
39+
This project includes a quick login feature. Simply add `/dev/login/{user_id}` to the URL to log in as a specific user.
4340

44-
### The default branch has been renamed!
41+
Example:
4542

46-
**9.x** is now named **laravel-9.x**
47-
48-
If you have a local clone, you can update it by running the following commands.
49-
50-
```bash
51-
git branch -m 9.x laravel-9.x
52-
git fetch origin
53-
git branch -u origin/laravel-9.x laravel-9.x
54-
git remote set-head origin -a
43+
```text
44+
http://localhost:8000/dev/login/1
5545
```
5646

57-
### About Laravel
58-
59-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and
60-
creative experience to be truly fulfilling.
61-
62-
### About Inertia.js
63-
64-
Inertia.js lets you quickly build modern single-page React, Vue and Svelte apps using classic server-side routing and
65-
controllers.
66-
67-
### About Typescript
68-
69-
Typescript is a strict syntactical superset of JavaScript and adds optional static typing to the language.
70-
71-
### Available scripts
72-
73-
Feel free to use someting like [pnpm](https://pnpm.io/) or [yarn](https://yarnpkg.com/). It just node package manager I
74-
have, so make yours.
75-
76-
```bash
77-
# Format with prettier
78-
bun run format
79-
80-
# Start development
81-
bun run dev
82-
83-
# Build the app
84-
bun run build
85-
86-
# Testing for SSR
87-
bun run preview
88-
```
89-
90-
### Update profile information
91-
92-
Of course it is not just about authentication, but also about updating user profile information, password, and deleting
93-
account.
94-
95-
### Dashboard Layout
96-
97-
This project has 3 layout:
98-
99-
1. Guest Layout
100-
2. App Layout (Default)
47+
This feature is only available in development mode (`APP_ENV=local` in `.env`). Ensure that a user with the specified ID exists in your database.
10148

102-
User layout will make a layout side by side, it has a sidebar. So this is will be useful when you need an admin panel or
103-
something like that.
49+
### Default Branch Renaming
10450

105-
If you like making new features, feel free to make a [pull request](https://github.com/irsyadadl/inertia.ts/pulls). I'll
106-
be happy to review it.
51+
The **9.x** branch is now named **laravel-9.x**.
10752

108-
## Sponsored
109-
- [Premium Blocks](https://blocks.getjustd.com)
110-
- [Parsinta](https://parsinta.com)
53+
If you have a local clone, you can update it accordingly.

0 commit comments

Comments
 (0)