Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/researchstudio-sat/won-valueflows-bot
https://github.com/researchstudio-sat/won-valueflows-bot
bot valueflows won-bot
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/researchstudio-sat/won-valueflows-bot
- Owner: researchstudio-sat
- License: apache-2.0
- Created: 2020-07-28T08:36:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T03:31:39.000Z (almost 2 years ago)
- Last Synced: 2024-03-26T12:30:45.873Z (8 months ago)
- Topics: bot, valueflows, won-bot
- Language: Java
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web of Needs Bot Skeleton
This skeleton contains a bot that creates a Service Atom that one can connect to.
For each atom that has been created on the configured node(s), the bot sends a message with the atomUri of the created Atom to everyone that is connected to the Service Atom.
The Bot Skeleton is a [Spring Boot Application](https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-running-your-application.html).
## Running the bot
### Prerequisites
- [Openjdk 8](https://adoptopenjdk.net/index.html) - the method described here does **not work** with the Oracle 8 JDK!
- Maven framework set up
- Use this repository as a template (green button in github GUI), fork it, or clone it.
### On the command line
```
cd bot-skeleton
export WON_NODE_URI="https://hackathonnode.matchat.org/won"
mvn clean package
java -jar target/bot.jar
```
Now go to [What's new](https://hackathon.matchat.org/owner/#!/overview) to find your bot, connect and [create an atom](https://hackathon.matchat.org/owner/#!/create) to see the bot in action.
### In Intellij Idea
1. Create a run configuration for the class `won.bot.valueflows.SkeletonBotApp`
2. Add the environment variables
* `WON_NODE_URI` pointing to your node uri (e.g. `https://hackathonnode.matchat.org/won` without quotes)
to your run configuration.
3. Run your configuration
If you get a message indicating your keysize is restricted on startup (`JCE unlimited strength encryption policy is not enabled, WoN applications will not work. Please consult the setup guide.`), refer to [Enabling Unlimited Strength Jurisdiction Policy](https://github.com/open-eid/cdoc4j/wiki/Enabling-Unlimited-Strength-Jurisdiction-Policy) to increase the allowed key size.
##### Optional Parameters for both Run Configurations:
- `WON_KEYSTORE_DIR` path to folder where `bot-keys.jks` and `owner-trusted-certs.jks` are stored (needs write access and folder must exist)
## Start coding
Once the skeleton bot is running, you can use it as a base for implementing your own application.
- Add/edit config files in `src/main/resources`
- Follow the [Mini HowTos](https://github.com/researchstudio-sat/webofneeds/tree/master/documentation/howto/README.md).
For an introduction to the Web of Needs Bot framework, have a look at the [Bot Readme](https://github.com/researchstudio-sat/webofneeds/blob/master/webofneeds/won-bot/README.md).