Skip to content

Commit

Permalink
feat/frontend: updated readme, refs: #50
Browse files Browse the repository at this point in the history
  • Loading branch information
MCatherine1994 committed Nov 15, 2022
1 parent ab7b703 commit ef02051
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

The frontend is written in [vue3](https://vuejs.org) in typescript. Using the [BC Parks Bootstrap theme](https://digitalspace.github.io/bcparks-bootstrap-theme/)
The frontend is written in [vue3](https://vuejs.org) composition api in typescript. Using the [BC Parks Bootstrap theme](https://digitalspace.github.io/bcparks-bootstrap-theme/)

## Setup local development

Expand All @@ -25,7 +25,7 @@ VITE_KEYCLOAK_REALM=[keycloak realm name]
[Bootstrap icon for vue3](https://github.com/tommyip/bootstrap-icons-vue), this doesn't work well with the bootstrap-vue-3 after installed bootstrap-vue-3 using the preferred method, so use unplugin-icons for now, until bootstrap-vue-3 adds the icons. bootstrap-icons-vue naming convention uses b-icon as prefix, so bootstrap-vue-3 will think it belongs to it, and then complains cannot found
**Unit Test**:
[Vitest](https://vitest.dev/api/)
[Vue test util](https://v1.test-utils.vuejs.org/api/)
[Vue test util](https://test-utils.vuejs.org/api/)

## Command

Expand Down Expand Up @@ -53,4 +53,7 @@ $ npm init vue@latest

## Reference reading

[vue3 composition api learning](https://vuejs.org/tutorial/#step-12)
[vue3 computed properties](https://vuejs.org/guide/essentials/computed.html)
[vue3 typescript with composition api](https://vuejs.org/guide/typescript/composition-api.html)
[Testing frameworks for vue](https://vuejs.org/guide/scaling-up/testing.html#unit-testing)

0 comments on commit ef02051

Please sign in to comment.