Skip to content

Commit 7fe798e

Browse files
committed
readme updated
1 parent 1a950aa commit 7fe798e

File tree

1 file changed

+57
-9
lines changed

1 file changed

+57
-9
lines changed

README.md

Lines changed: 57 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,30 +39,78 @@ Build premium quality applications with ease. Use our innovative admin template
3939

4040
> We recommend you use yarn
4141
42-
1. Install all packages
42+
1. Install composer packages
43+
44+
```bash
45+
composer install
46+
47+
```
48+
49+
2. In the root directory, you will find a file named .env.example, rename the given file name to .env and run the following command to generate the key (You can also setup your database credentials here).
50+
51+
```bash
52+
php artisan key:generate
53+
54+
```
55+
56+
3. By running the following command, you will be able to get all the dependencies in your node_modules folder:
4357

4458
```bash
4559
yarn
4660

47-
# npm install [for npm]
61+
# npm install [for npm]
62+
```
63+
64+
4. To run the project, you need to run following command in the project directory. It will compile the php files & all the other project files. If you are making any changes in any of the php file then you need to run the given command again.
65+
66+
```bash
67+
yarn dev
68+
69+
# npm run development [for npm]
4870
```
4971

50-
2. Run development server
72+
5. To serve the application you need to run the following command in the project directory. (This will give you an address with port number 8000.)
5173

5274
```bash
53-
yarn serve
75+
php artisan serve
5476

55-
# npm run serve [for npm]
5677
```
5778

58-
3. Generate build files for deployment
79+
6. To change the port address, run the following command:
5980

6081
```bash
61-
yarn build
82+
php artisan serve --port=8080 // For port 8080
83+
sudo php artisan serve --port=80 // If you want to run it on port 80, you probably need to sudo.
84+
85+
```
86+
87+
7. `Watching for changes`: If you want to watch all the changes you make in the application then run the following command in the root directory.
88+
89+
```bash
90+
yarn watch
91+
92+
# npm run watch [for npm]
93+
```
6294

63-
# npm run build [for npm]
95+
8. `Building for Production:` If you want to run the project and make the build in the production mode then run the following command in the root directory, otherwise the project will continue to run in the development mode.
96+
97+
**Make sure to change the APP_ENV=local variable's value APP_ENV=production.**
98+
99+
```bash
100+
yarn prod
101+
102+
# npm run production [for npm]
64103
```
65104

105+
## Required Permissions
106+
107+
If you are facing any issues regarding the permissions, then you need to run the following command in your project directory:
108+
109+
```
110+
sudo chmod -R o+rw bootstrap/cache
111+
sudo chmod -R o+rw storage
112+
```
113+
66114
## What's Included 📦
67115

68116
- Dashboard
@@ -142,7 +190,7 @@ Contribution are always welcome and recommended! Here is how:
142190
Please refer to the [CHANGELOG](CHANGELOG.md) file. We will add a detailed release notes to each new release.
143191

144192
## Credits 🙏
145-
193+
- [Laravel](https://laravel.com/)
146194
- [Vuetify](https://vuetifyjs.com/)
147195
- [Material Design Icons](https://materialdesignicons.com/)
148196
- [ApexCharts](https://apexcharts.com/)

0 commit comments

Comments
 (0)