Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/SolidOS/activitystreams-pane

A visualization of Activity Streams types for solid-panes
https://github.com/SolidOS/activitystreams-pane

react storybook webpack

Last synced: about 1 month ago
JSON representation

A visualization of Activity Streams types for solid-panes

Awesome Lists containing this project

README

        

# activitystreams-pane

A visualization of [Activity Streams](https://www.w3.org/TR/activitystreams-vocabulary/) types for solid-panes.

## Demo

📗 [Storybook](https://solid.github.io/activitystreams-pane/)

## Currently supported types

- [Note](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note)

## Contribute

### Tech stack

- Typescript
- React
- Jest
- Eslint
- SolidOS

### Tests

To run all tests:
```shell script
npm run test
npm run test:e2e
```

#### Unit tests

Unit tests use `jest` and are placed next to the tested file as `*.spec.ts` files.

#### E2E tests

End-to-End (E2E) tests verify the rendering of the whole pane and are placed under `./e2e-tests`.

### Dev Server

Start a webpack dev server:

```shell script
npm start
```

Visit `http://localhost:8080/` to render the pane. Adjust `const noteUri` in `./dev/index.ts` to show a
different resource.

### Build

```
npm run build
```

The build is done by `tsc`, webpack is only used as dev server and not for production build.