Skip to content
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

Release/v0.0.5 #3

Closed
wants to merge 8 commits into from
Closed

Release/v0.0.5 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5dcd443
minor: add link to refs
0gust1 Sep 12, 2023
361f65a
minor: readme
0gust1 Sep 13, 2023
274e4e6
feat: new element - load a structure and select one of its chain
0gust1 Sep 13, 2023
ca9632c
refactor: elements demo + URLchain POC
0gust1 Sep 13, 2023
8de680c
minor: roadmap update
0gust1 Sep 13, 2023
1a6a922
Merge pull request #1 from 0gust1/feat/chain-loader
0gust1 Sep 14, 2023
f9525c7
chore: update deps, and fix readme badges alt text
0gust1 Sep 14, 2023
89ec159
Merge pull request #2 from 0gust1/chore/deps_update
0gust1 Sep 14, 2023
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
19 changes: 6 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,19 @@ This is a collection of [Svelte](https://svelte.dev) components for [Mol\*](http
The goal is to provide a set of composable components that can be used to build web applications/components/websites providing visualization and analysis of biomolecular structures.
The components are designed to be used in a [Svelte](https://svelte.dev) application, ~~but could be used in any framework that supports [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components)~~ (later).

![example event parameter](https://github.com/0gust1/molstar-svelte/actions/workflows/build.yml/badge.svg?event=push) ![example event parameter](https://github.com/0gust1/molstar-svelte/actions/workflows/deploy.yml/badge.svg?event=push) ![example event parameter](https://github.com/0gust1/molstar-svelte/actions/workflows/publish.yml/badge.svg?event=release)
![build status badge](https://github.com/0gust1/molstar-svelte/actions/workflows/build.yml/badge.svg?event=push) ![deploy status badge](https://github.com/0gust1/molstar-svelte/actions/workflows/deploy.yml/badge.svg?event=push) ![publish status badge](https://github.com/0gust1/molstar-svelte/actions/workflows/publish.yml/badge.svg?event=release)

## Documentation / showcase

[https://0gust1.github.io/molstar-svelte/](https://0gust1.github.io/molstar-svelte/)

## Developing
## Development

Install the dependencies...

```bash
# we use npm ci to install the pinned dependencies from package-lock.json
npm ci
```


```bash
npm run dev

# or start the server and open the app in a new browser tab
Expand All @@ -46,13 +42,10 @@ npm run build

You can preview the production build with `npm run preview`.

## Publishing
## Updating the documentation/showcase

Website/doc deploymen is done through github actions.
Website/doc deployment is done through github actions, on push on `master`

**TODO:**
package publishing is not yet automated.
## Publishing

```bash
npm publish
```
Publishing is done through github actions, on release creation on `master`.
Loading