Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wbstack/ui
Main VueJS based site for wikibase.cloud
https://github.com/wbstack/ui
vue wbstack wikibase
Last synced: 16 days ago
JSON representation
Main VueJS based site for wikibase.cloud
- Host: GitHub
- URL: https://github.com/wbstack/ui
- Owner: wbstack
- License: gpl-3.0
- Created: 2020-10-31T09:20:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T08:03:01.000Z (8 months ago)
- Last Synced: 2024-04-09T09:26:35.142Z (8 months ago)
- Topics: vue, wbstack, wikibase
- Language: Vue
- Homepage: https://wikibase.cloud
- Size: 8.12 MB
- Stars: 3
- Watchers: 9
- Forks: 7
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - wbstack/ui - Main VueJS based site for wikibase.cloud (vue)
README
> ℹ️ Issues for this repository are tracked on [Phabricator](https://phabricator.wikimedia.org/project/board/5563/) - ([Click here to open a new one](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?tags=wikibase_cloud,wbstack_ui
))
# wbstack UI
The code for the https://wikibase.cloud/ website (previously wbstack.com).
## Development
For a detailed explanation on how things work, check out the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
This app uses https://cli.vuejs.org.
### Docker Environment
#### Installing dependencies
```
docker compose run ui npm install
```
#### Starting the server
```
docker compose up -d
```
#### Running scripts
```
docker compose run ui npm run
```
### Bare-metal Environment
#### Installing dependencies
```
npm install
```
#### Starting the server
```
npm run serve
```
#### Building for production
```
npm run build
```
### Mocked API
This ui uses Mock Service Worker (https://mswjs.io/) to mock the backend api for test purposes.
To run dev server with mocked api, set env variable `API_MOCK` to a value that evaluates to `true`.
This can either be done at runtime using npm, or in `.env` for docker-compose.
```
VUE_APP_API_MOCK=1 npm run serve
```
Currently, logging in using any email and password will behave as if the same user is always logging in.
Created wikis by that user will live in local storage (`msw-myWikis` key)
Backend api mocks live in `/src/backend/mocks/default_handlers.js`.
**Note**
Firefox blocks service workers as long as we use `localhost` for local development. The only solution is to use
chrom(ium) for now.
### Running browser tests
```sh
rm -r node_modules
docker compose run ui npm install
docker compose --profile browser-tests up -d
docker compose exec -it ui npm run test:e2e
docker compose --profile browser-tests down
```