https://civictechto.github.io/polis-storybook/
https://civictechto.github.io/polis-storybook/
hacktoberfest storybook testing
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://civictechto.github.io/polis-storybook/
- Owner: CivicTechTO
- License: agpl-3.0
- Created: 2024-09-22T21:35:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T05:01:48.000Z (8 months ago)
- Last Synced: 2024-10-24T16:25:43.363Z (8 months ago)
- Topics: hacktoberfest, storybook, testing
- Language: JavaScript
- Homepage: https://civictechto.github.io/polis-storybook/
- Size: 1.21 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-polis - Storybook: Polis - A "storybook" instance to display frontend UI components from Polis and its forks, to allow more collaboration and experimentation on UX and accessibility improvements. [Source](https://github.com/CivicTechTO/polis-storybook) (Misc)
README
# Storybook: Polis
[](https://github.com/CivicTechTO/polis-storybook/actions/workflows/deploy-github-pages.yml)
The **purpose** of this Storybook component environment is to allow more lightweight and inclusive development of the Polis UI by both designers and developers, with particular intention toward improving accessibility. A secondary goal is to allow for more rapid iteration on the experience of interacting with Polis.
We automatically deploy the most recent version on GitHub Pages:
https://civictechto.github.io/polis-storybook/
## Goals
- Display all React components in Storybook.
- Any React components within Polis' client apps: `admin`, `participation` & `report`.
- Only React components, not legacy BackboneJS views.
- Make minimal changes to upstream Polis codebase to get Storybook working. ([diff][polis-diff])
- Allow any frontend designer with NodeJS installed to work on Polis UI locally within minutes.
- Avoid forcing contributors to set up and run Docker.
## Development
Requirements:
- :white_check_mark: NodeJS v18 (tested on v18.17.1)
- :white_check_mark: Git
- :x: Docker (not needed)
```
git checkout https://github.com/CivicTechTO/polis-storybook
cd polis-storybook
git submodule update --init
npm install
npm run storybook
```
A browser window will open automatically: http://localhost:6006
(If you have the `make` command installed, you may run `make` to see the helper tasks it can help you run.)
## Technologies Used
- [**Storybook.**][storybook] A frontend workshop for building UI components and pages in isolation.
- **React.**
- [**GitHub Pages.**][github-pages]
- [**GitHub Actions.**][github-actions]
- [**BackboneJS.**][backbone] (legacy) A lightweight MVC framework for structuring JS apps.
- [**Handlebones.**][handlebones] (legacy) A tiny Backbone + Handlebars view framework.
## License
GNU Affero General Public License v3.0 (See [LICENSE](./LICENSE))
[polis-diff]: https://github.com/compdemocracy/polis/compare/edge...CivicTechTO:polis:storybook-prep
[storybook]: https://storybook.js.org/
[github-actions]: https://github.com/features/actions
[github-pages]: https://pages.github.com/
[backbone]: https://backbonejs.org/
[handlebones]: https://github.com/FormidableLabs/handlebones