Skip to content

Commit b97ee64

Browse files
committed
update README with v2 upgrade guide
1 parent f63fcce commit b97ee64

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Example Quasar(Vue) SPA skeleton frontend to be used with a Laravel 8 project.
66

77
This project uses:
88

9-
- Quasar [QEnv extension](https://github.com/quasarframework/app-extension-qenv/tree/dev/app-extension) to customize API URI depending on your environment.
9+
- ~~Quasar [QEnv extension](https://github.com/quasarframework/app-extension-qenv/tree/dev/app-extension) to customize API URI depending on your environment.~~ Removed in v2
1010
- Vuex state to handle the user authentication
11-
- For the local environment, it uses the webpack's proxy feature to proxy API calls(see [here](https://github.com/training-yoyosan/example-frontend/blob/master/quasar.conf.js#L72)).
11+
- For the local environment, it uses the webpack's proxy feature to proxy API calls(see [here](https://github.com/training-yoyosan/example-frontend/blob/master/quasar.conf.js#L77)).
1212

1313
## Demo
1414

@@ -63,31 +63,46 @@ Now access the application at http://localhost:8080.
6363
yarn
6464

6565
# setup env
66-
cp .quasar.env.sample.json .quasar.env.json
67-
vim .quasar.env.json
66+
cp .env.sample .env
67+
vim .env
6868
## Adjust API_BASE_URL
6969
```
7070

7171
### Build
7272

7373
```bash
7474
yarn run build
75-
# or
76-
QENV=production quasar build
7775

7876
# Adjust your server configuration according to
79-
# https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations
77+
# https://next.router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations
8078

8179
# For Apache(optional)
8280
cp .htaccess dist/spa
8381
```
8482

8583
Deploy on your server.
8684

87-
**Note**: If you use HTTPS, use the protocol in your `.quasar.env.json` file.
85+
**Note**: If you use HTTPS, use the protocol in your `.env` file.
86+
87+
## Upgrade guide to v2
88+
89+
```bash
90+
git pull
91+
# remove packages related folders and files
92+
rm -rf node_modules/ .quasar/ yarn.lock
93+
# copy and update the .env file
94+
cp .env.sample .env
95+
# remove the old quasar env file
96+
rm .quasar.env.json
97+
98+
yarn
99+
100+
yarn run build
101+
```
102+
103+
Find out more in the [official upgrade guide](https://quasar.dev/start/upgrade-guide).
88104

89105
## Resources
90106

91107
- https://quasar.dev/introduction-to-quasar
92-
- https://github.com/quasarframework/app-extension-qenv/tree/dev/app-extension
93108
- Quasar Discord #laravel channel

0 commit comments

Comments
 (0)