Skip to content

Commit eea9a20

Browse files
miguewebmigueweb
committed
docs: update readme.md and contributing.md
1 parent 76fe990 commit eea9a20

File tree

3 files changed

+75
-70
lines changed

3 files changed

+75
-70
lines changed

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Contributing
22
Thank you for your interest in contributing to laravel aliases! We welcome all contributions, big and small.
33

4+
## Useful resources
5+
- [Learn bash](https://learn-bash.org/)
6+
7+
## Issues
8+
- Use a clear and descriptive title for the issue to identify the problem.
9+
- Describe the exact steps which reproduce the problem in as many details as possible.
10+
411
## Pull Requests
512
- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Your patch won't be accepted if it doesn't use Conventional Commits
613
- Provide a clear and descriptive title for your pull request
714
- One pull request per feature. If you want to do more than one thing, send multiple pull requests.
815

9-
Happy coding!
16+
Happy coding! 🐱‍💻

‎README.md‎

Lines changed: 67 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# laravel-aliases
1+
![](picture.webp)
2+
3+
<p align="center">
4+
<a href="https://github.com/migueweb/laravel-aliases/blob/main/LICENSE">
5+
<img alt="GitHub" src="https://img.shields.io/github/license/migueweb/laravel-aliases">
6+
</a>
7+
</p>
8+
9+
# Laravel aliases
210

311
Terminal tool to enhance laravel artisan experience and productivity.
412

@@ -14,73 +22,63 @@ Terminal tool to enhance laravel artisan experience and productivity.
1422
```bash
1523
sh -c "$(curl -fsSL https://raw.githubusercontent.com/migueweb/laravel-aliases/main/install.sh)"
1624
```
17-
## Usage
18-
19-
Commands have a default structure in which they take the first two letters of the original artisan command group and the first three letters of the command but there are exceptions for example commands that only take the first two letters or the first three letters of the original or others that add three extra letters at the end.
20-
21-
```bash
22-
cache:clear # cache is the command group and clear is the command
23-
ca:cle # Laravel-aliases
24-
```
25-
26-
To see all the commands use `laravel-aliases` or `lases`
27-
28-
### execptions
29-
30-
Commands using only the first letter of the original artisan command
31-
32-
- queue: q
33-
- make: m
34-
- route: r
35-
36-
Commands using only the three first letters of the original artisan command
37-
38-
- schedule: sch
39-
40-
#### utilities
41-
42-
`art` is a equivalent to `php artisan`
43-
e.g
44-
45-
```bash
46-
# laravel-aliases
47-
art --version
48-
49-
# artisan
50-
php artisan --version
51-
```
52-
53-
There are also commands that help you to write less code, such as these
54-
55-
```bash
56-
mc Example
57-
# php artisan make=controller ExampleController
58-
59-
mcr Example
60-
# php artisan make=controller ExampleController --resource
61-
62-
mf Example
63-
# php artisan make:factory ExampleFactory
64-
65-
mmg examples
66-
# php artisan make:migration create_examples_table;
67-
68-
mrq Example
69-
# php artisan make:request ExampleRequest
70-
71-
ms Example
72-
# php artisan make:seeder ExampleSeeder
73-
74-
mfs
75-
# php artisan migrate:fresh --seed
76-
77-
rl
78-
# php artisan route:list
79-
80-
key
81-
#php artisan key:generate
82-
```
8325

84-
## Contributing
26+
## Usage
8527

86-
Please see [contributing.md](CONTRIBUTING.md) for details.
28+
Commands have a default structure in which they take the first two letters of the original artisan command group and the first three letters of the command, but there are exceptions, for example commands that only take the first two letters or the first three letters of the original or others that add three extra letters at the end.
29+
30+
### Example
31+
32+
`php artisan cache:clear`
33+
cache is the command group and clear is the command and `ca:cle` is the Laravel aliases equivalent
34+
35+
### Commands
36+
37+
| Artisan | Laravel aliases |
38+
| ------------ | --------------- |
39+
| auth | au |
40+
| cache | ca |
41+
| config | co |
42+
| db | db |
43+
| env | en |
44+
| event | ev |
45+
| jetstream | je |
46+
| lang | la |
47+
| livewire | li |
48+
| make | m |
49+
| migrate | mi |
50+
| model | mo |
51+
| notification | no |
52+
| optimize | op |
53+
| package | pa |
54+
| queue | q |
55+
| route | r |
56+
| sail | sa |
57+
| sanctum | san |
58+
| schedule | sch |
59+
| session | se |
60+
| storage | st |
61+
| stub | st |
62+
| vendor | ve |
63+
| view | vi |
64+
65+
66+
If you want to use commands without group like serve, migrate, tinker, etc. You can use `art` before of command, this is an equivalent to `php artisan`. Example `art serve` equivalent to `php artisan serve`
67+
68+
### Extra commands
69+
70+
| Laravel Aliases | Artisan |
71+
| --------------- | ---------------------------------------------------------- |
72+
| `mc Example` | `php artisan make:controller ExampleController` |
73+
| `mcr Example` | `php artisan make:controller ExampleController --resource` |
74+
| `mf Example` | `php artisan make:factory ExampleFactory` |
75+
| `mmg examples` | `php artisan make:migration create_examples_table` |
76+
| `mrq Example` | `php artisan make:request ExampleRequest` |
77+
| `ms Example` | `php artisan make:seeder ExampleSeeder` |
78+
| `mfs` | `php artisan migrate:fresh --seed` |
79+
| `rl` | `php artisan route:list` |
80+
| `key` | `php artisan key:generate` |
81+
82+
## 🤝 Contributing
83+
84+
Hey if you want to add more documentation, aliases, functions, improve the code or report issues, you are welcome. Please see 😉👉 [contributing.md](CONTRIBUTING.md) for details.

‎picture.webp‎

41.8 KB
Loading

0 commit comments

Comments
 (0)