Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
suecharo committed Apr 13, 2022
1 parent a5b4b6d commit cb6c2b4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2021 DDBJ(DNA Data Bank of Japan) [email protected]
Copyright 2021 DDBJ(Bioinformatics and DDBJ Center) [email protected]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# yevis-web

Web application for browsing workflows deployed by [`ddbj/yevis-cli`](https://github.com/ddbj/yevis-cli).
Web application for browsing Yevis workflow registry.

[https://ddbj.github.io/yevis-web/](https://ddbj.github.io/yevis-web/) is deployed for [`ddbj/yevis-workflows`](https://github.com/ddbj/yevis-workflows).
**[https://ddbj.github.io/yevis-web/](https://ddbj.github.io/yevis-web/)** is deployed for [`ddbj/workflow-registry`](https://github.com/ddbj/workflow-registry).

In addition, see the below links:

- [`ddbj/workflow-registry`](https://github.com/ddbj/workflow-registry): a workflow registry built and maintained by [DDBJ](https://www.ddbj.nig.ac.jp/) using `yevis-cli`
- [`ddbj/yevis-cli`](https://github.com/ddbj/yevis-cli): a CLI tool to support building and maintaining Yevis workflow registry
- [`Yevis Getting Started`](https://github.com/ddbj/yevis-cli/blob/main/docs/getting_started.md): the document for Yevis system installation and usage
- [`Yevis Getting Started Ja`](https://github.com/ddbj/yevis-cli/blob/main/docs/getting_started_ja.md): 日本語での Yevis system の使い方

## Development

Expand Down Expand Up @@ -50,9 +57,9 @@ Create a `.env` file and set them to change them.

---

To deploy the `yevis-web` to GitHub Pages, the application `base` needs to be set. (See [Vite - Guide - GitHub Pages](https://vitejs.dev/guide/static-deploy.html#github-pages) as a reference)
To deploy `yevis-web` to GitHub Pages, application `base` needs to be set. (See [Vite - Guide - GitHub Pages](https://vitejs.dev/guide/static-deploy.html#github-pages) as a reference)

Pass the environment variable `YEVIS_WEB_BASE` to set the `base` at build time:
Pass the environment variable `YEVIS_WEB_BASE` to set `base` at build time:

```bash
$ YEVIS_WEB_BASE=/yevis-web/ npm run build
Expand All @@ -70,4 +77,5 @@ $ gh-pages -d ./dist

## License

[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). See the [LICENSE](https://github.com/ddbj/yevis-cli/blob/main/LICENSE).
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
See the [LICENSE](https://github.com/ddbj/yevis-cli/blob/main/LICENSE).

0 comments on commit cb6c2b4

Please sign in to comment.