A project that collects user data from a particular Clubhouse channel and displays the data on a dashboard.
- Background Jobs: Utilizes the unofficial Clubhouse API by seia-soto to aggregate user data every minute and persist it in a database.
- GraphQL server: Serves the aggregated data.
- Dashboard: Displays User Rankings and Daily Active Users.
- Go to the
serverfolder - Copy
.env-exampleand rename it to.env - Config your MySQL & Redis in
.env - Install the dependencies:
yarn install
-
Background Jobs (Deprecated due to the breaking change of the API)
- Start the background jobs:
yarn start-jobs
- Start the background jobs:
-
GraphQL Server
- Start the GraphQL server:
yarn start
- Start the GraphQL server:
- Go to the
dashboardfolder - Install the dependencies:
yarn install - Start the dev server:
yarn serve
This project is not affiliated with Clubhouse and is solely for research purposes.
MIT License
Copyright (c) 2023 satgi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.