Skip to content

Commit f5bfe6d

Browse files
committed
Improve frontend readme
1 parent 8b27758 commit f5bfe6d

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

frontend/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# BSA 2019 Thread project (frontend)
22

3+
## Technologies
4+
5+
* [Vue.js](https://vuejs.org/) framework
6+
* [vue-cli](https://cli.vuejs.org/)
7+
* [vue-router](https://router.vuejs.org/)
8+
* [vuex](https://vuex.vuejs.org/)
9+
* [Buefy](https://buefy.org/) UI framework
10+
* [pusher-js](https://github.com/pusher/pusher-js)
11+
312
## Getting started
413

514
Install the following packages prior to standing up your development environment:
@@ -13,14 +22,14 @@ cp .env.example .env.local
1322
yarn install
1423
```
1524

16-
Configure your .env.local
25+
Configure your `.env.local`:
1726
```
1827
VUE_APP_API_URL=http://<host>:<port>/api/v1
1928
VUE_APP_PUSHER_APP_KEY=<pusher-app-key>
2029
VUE_APP_PUSHER_APP_CLUSTER=<pusher-app-cluster>
2130
VUE_APP_PUSHER_APP_AUTH_ENDPOINT=http://<host>:<port>/broadcasting/auth
2231
```
2332

24-
Replace `<host>` and `<port>` according to your backend url. You should register and create application on [Pusher](https://pusher.com/) site to get `<pusher-app-key>` and `<pusher-app-cluster>` variables.
33+
Replace `<host>` and `<port>` according to your backend URL. You should register an account and create an application on [Pusher](https://pusher.com/) site to get `<pusher-app-key>` and `<pusher-app-cluster>` variables. These credentials also should be used on the backend.
2534

2635
After that application is ready. You can run it in development mode with `yarn run serve` or `yarn run build` to generate compiled and minified files.

0 commit comments

Comments
 (0)