https://github.com/minskylab/supersense
Supersense is a simple and customizable events board, at the moment offers only two external event sources: Twitter and GitHub. The idea is implement another sources, Supersense has been developed with a strong focus extensibility.
https://github.com/minskylab/supersense
customizable-events-board event-board github-events social-wall twitter
Last synced: about 1 month ago
JSON representation
Supersense is a simple and customizable events board, at the moment offers only two external event sources: Twitter and GitHub. The idea is implement another sources, Supersense has been developed with a strong focus extensibility.
- Host: GitHub
- URL: https://github.com/minskylab/supersense
- Owner: minskylab
- License: mit
- Created: 2020-08-04T07:29:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:56:34.000Z (over 2 years ago)
- Last Synced: 2024-06-19T02:11:04.202Z (almost 2 years ago)
- Topics: customizable-events-board, event-board, github-events, social-wall, twitter
- Language: Go
- Homepage:
- Size: 6.98 MB
- Stars: 8
- Watchers: 3
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: security/jwt.go
Awesome Lists containing this project
README
# Supersense
Supersense is a simple and customizable event board. The main goal of supersense is given an open source alternative to the social walls or multiple source event trackers. At the moment, supersense implements only two sources: Twitter & Github, but the architecture was development in a scalable and extendable way.
## Technology
Supersense was created with a micro-service paradigm in mind, is a stateless service easy to horizontal scale (but also can have persistence and to be an stateful service). The project has two principal services called: **Core** and **Observer**, each one is distributed using docker images and published in the DockerHub with the tags **minskylab/supersense** and **minskylab/supersense-observer** respectively.
### About the stack
**Core**
Supersense Core was written in [Go](https://golang.org) and uses [GraphQL](https://graphql.org) as API layer to communicate with the observer or any other custom API consumer, the main goal of core is provide a powerful and realtime API to broadcast all the events coming from the configurase sources (Twitter, Github, etc...).
**Observer**
Supersense Observer was build with [Typescript](https://www.typescriptlang.org) and [React](https://reactjs.org/), and all the source are bundled\* using [snowpack](https://www.snowpack.dev/) a interesting modern technology that use a modern feature called [ESM](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/) (ES Modules) to distribute files in a unbundled mode, hence we have very fast development flow.
\* Snowpack offers two ways to use it, with its unbundled proposal using ESM and another where you can use the classical bundlers (like Webpack, Parcel).
### Architecture
### Getting Started
Write a .env config file like:
```dotenv
# .env file
SS_GRAPHQL_PLAYGROUND=true
SS_TWITTER_CONSUMER_KEY=
SS_TWITTER_CONSUMER_SECRET=
SS_TWITTER_ACCESS_TOKEN=
SS_TWITTER_ACCESS_SECRET=
SS_TWITTER_QUERY="#peru"
SS_GITHUB_TOKEN=
SS_GITHUB_REPOS=minskylab/supersense,minskylab/figport,minskylab/base
```
Supersense core is delivered using docker hub. To run only, execute:
```shell script
$ docker run -p 8080:8080 --env-file .env minskylab/supersense
```
// TODO
// TODO
## Configuration
Currently supersense only accepts one way to config the service parameters: the environment variables. Below you can see all of this variables.
| Environment Variable Name | Default Value | Description |
| ------------------------------ | :------------ | ----------- |
| SS_PORT | 4000 | |
| SS_TWITTER_CONSUMER_KEY | - | |
| SS_TWITTER_CONSUMER_SECRET | - | |
| SS_TWITTER_ACCESS_TOKEN | - | |
| SS_TWITTER_ACCESS_SECRET | - | |
| SS_TWITTER_QUERY | - | |
| SS_GITHUB_TOKEN | - | |
| SS_GITHUB_REPOS | - | |
| SS_DUMMY_PERIOD | - | |
| SS_DUMMY_MESSAGE | - | |
| SS_SPOKESMAN | false | |
| SS_SPOKESMAN_NAME | - | |
| SS_SPOKESMAN_USERNAME | - | |
| SS_SPOKESMAN_EMAIL | - | |
| SS_PERSISTENCE | false | |
| SS_PERSISTENCE_BOLTDB_FILEPATH | - | |
| SS_PERSISTENCE_REDIS_ADDRESS | - | |
| SS_PERSISTENCE_REDIS_PASSWORD | - | |
| SS_GRAPHQL_PLAYGROUND | false | |
// TODO
- [ ] More easy observer configuration
- [x] Twitter Images
- [x] Github project summary
- [x] Github open issues (extends the event demux)
- [x] Deployment Instructions
### Deploy with Helm
Before your deploy in your k8s cluster you need declare a secret with your configuration.
You need to define a .env file with your configuration and use the following command to create a kubernetes generic secret.
```shell script
$ kubectl create secret generic --from-env-file=.env
```
Then, now add the minsky charts repository and install supersense setting your secretRef.
```shell script
$ helm repo add minsky https://charts.minsky.cc
$ helm repo update # optional
$ helm install minsky/supersense --set config.secretRef=
```