https://github.com/bjoern-hempel/reveal-sentiment
Reveal Sentiment is a political sentiment survey tool based on the Reveal.js framework. This tool allows users to express their current political mood and receive related ideas and suggestions.
https://github.com/bjoern-hempel/reveal-sentiment
Last synced: 2 months ago
JSON representation
Reveal Sentiment is a political sentiment survey tool based on the Reveal.js framework. This tool allows users to express their current political mood and receive related ideas and suggestions.
- Host: GitHub
- URL: https://github.com/bjoern-hempel/reveal-sentiment
- Owner: bjoern-hempel
- License: other
- Created: 2024-06-15T14:15:42.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T21:00:21.000Z (11 months ago)
- Last Synced: 2024-12-27T03:13:12.433Z (4 months ago)
- Language: JavaScript
- Size: 3.17 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Reveal Sentiment
[](LICENSE)
Reveal Sentiment is a political sentiment survey tool based on the Reveal.js framework. This tool allows users to express their current political mood and receive related ideas and suggestions.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/bjoern-hempel/reveal-sentiment.git
```
2. Navigate to the project directory:
```bash
cd reveal-sentiment
```
3. Install dependencies:
```bash
npm install
```
## Usage
1. Start the local server:
```bash
npm start -- --port=8888
```
2. Open your browser and go to http://localhost:8888.
## Customization
The slides are automatically generated from a YAML file located at [plugin/yaml-section-builder/config.yml](/plugin/yaml-section-builder/config.yml).
You can modify this file to change the content of the survey.
## Deployment
1. Create package
```bash
npm run package
```
This command creates a ready-to-use reveal-js-presentation.zip package. The package can be transferred and unpacked on
any web server (only static files are needed).
## License
This library is licensed under the MIT License - see the [LICENSE.md](/LICENSE.md) file for information.
MIT reveal.js license - see [LICENSE](https://github.com/hakimel/reveal.js/blob/master/LICENSE)
## Contact
If you have any questions or suggestions, feel free to contact me:
* Name: Björn Hempel
* Email: [email protected]
Thank you for using Reveal Sentiment!
## Demo
A demo is available at: https://sentiment.ixno.de/
* Username: `sentiment`
* Password: `Imenirasopo443`