Skip to content

Fix the README.md #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Fix the README.md #503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Web Sequence
#Web Sequence

[![Gitter](https://badges.gitter.im/zenuml/Lobby.svg)](https://gitter.im/zenuml/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![HitCount](http://hits.dwyl.com/zenuml/web-sequence.svg?style=flat-square)](http://hits.dwyl.com/zenuml/web-sequence)
Expand All @@ -13,11 +13,11 @@

We will discuss deployment of the following items:

| App/Plugin | Target | Local | Console | Travis-CI |
|------------------|-----------|-------|---------|-----------|
| Web App | Firebase | Y | N | Y |
| Functions | Firebase | Y | N | N |
| Chrome extension | Web store | Y | Y | N |
| App/Plugin | Target | Local | Web Console | Github Actions |
|------------------|-----------|-------|-------------|----------------|
| Web App | Firebase | Y | N | Y |
| Functions | Firebase | Y | N | N |
| Chrome extension | Web store | Y | Y | N |


### Web App and Chrome extension
Expand All @@ -32,12 +32,15 @@ Shared steps - build and test:
1. `access localhost instead of 127.0.0.1` to allow firebase access

#### Chrome extension
1. Update `version` in `extension/manifest.json`
1. Zip the `extension` folder
1. `yarn upload` to upload the extension to Google Web Store
1. `yarn pub` to publish the extension

> Optimisation: The #3 step in the shared steps would generate a zip file. The #2 step can be omitted if
1. Update `version` in `src/manifest.json`
2. `yarn build` to build the product release
3. `yarn release` to build the Chrome extension
4. Use the ZenUml extension to the Chrome Browser
1. Chrome -> settings -> extensions
2. Enable 'Developer Mode'
3. Load the unpacked extensions: folder ./extension

> Optimisation: The #3 step in the shared steps would generate a zip file. The #2 step can be omitted if
we pass the generated zip file name to the script of `yarn upload` and `yarn pub`.

##### Post deployment
Expand Down Expand Up @@ -67,8 +70,7 @@ $ yarn install // instal modules
$ yarn start // start a local server

$ yarn build // build a staging release
$ yarn build-prod // build a production release
$ gulp release // copy resources to app / extension
$ yarn release // copy resources to app / extension
````

#### Enable/Disable DEBUG
Expand Down