🪼 Cially

Cially is an open source dashboard that allows you to view detailed insights regarding your Discord Server!

🐚 Features

• Shows the name, description, icon and current members
• Shows if the server is in an outage
• Shows if a server is Discord Partnered
• Shows the creation date of your server
• Shows the owner of the server
• Shows the number of channels, roles & bans
• Shows the Vanity URL and the total uses
• Shows Message Data
  • Messages sent per hour
  • Messages sent per day
  • Messages sent per week
  • Total Messages Ever Sent
  • Tota Media (Photos/Videos) ever sent
  • Total Message Deletions
  • Total Message Edits
• Shows Activity Data
  • Most Active Channels
  • Most Active Users
  • Most Active Hours
  • Total Online/Idle/Offline Members
• Beautiful User Friendly UI
• Responsive for every device
• More Features to come in the future...

🐟 Screenshots

🐠 How it works

Cially Dashboard is powered by a Discord Bot, a full-stack Next.js application, and Pocketbase as the backend. The Discord Bot actively listens to all events happening on your server and logs them to the database via its own API. The web application then retrieves this data from the database to display detailed insights and information to the user. Since the database stores data using IDs (for users, channels, etc.), the website communicates directly with the bot to resolve these IDs into human-readable names and to fetch the most up-to-date information on demand. All ongoing synchronization and data enrichment—such as resolving names or syncing recent activity—is handled seamlessly between the bot and the website.

🪸 How to run

There is a Docker Image inlcuded in the Source Code! However, please take a look at the Manual Installation Instructions bellow for futher information regarding setting Cially up!

Pocketbase Instance

1. Install Pocketbase 0.26.0
2. Run ./pocketbase serve to start the backend
3. Open the URL displayed on your terminal and create an admin account
4. Go to Settings -> Import -> Load from JSON file
5. Upload the pb_schema json file that can be found in the /pocketbase directory
6. Review Changes and then apply them

Warning

Do not change anything in the database if you don't know what you are doing! Changing a small detail might break the dashboard

Discord Bot

1. Go to Discord Developer Portal and create a new Application
2. Go to Bot Section and enable all the of Privileged Gateway Intents as shown in the picture bellow
3. Invite the Bot to your Discord Server
4. Give it permissions to View Channel & View Message History on every channel you want the bot to track

Tip

OPTIONAL Give the bot Manage Server permission if you want it to track Vanity URL Uses

5. Clone the /cially-bot directory where you want the Bot Code to run on.
6. Rename .env.example file to .env and replace each value. There are instructions for each variable so you will know what to change

Website

1. Clone the ./cially-webserver directory where you want the Website Code to run on
2. Rename .env.example file to .env and replace each value. There are instructions for each variable so you will know what to change
3. Run npm run build to build the website.

Tip

If you are a beginner, you can use tools Coolify to simplify the hosting process. Check Coolify's Docs for more info!

And that's it! Once a new message is being detected by the bot for the first time, everything should start to work automatically! All you need to do is go to your Dashboard Page, paste your Server ID and all the data will be displayed!

Caution

Only the events that happened while the bot is up and running are being tracked and displayed on the dashboard! Older events (such as older messages) or events that happened while the bot was offline for whatever reason are NOT being tracked. Therefore, the data will be inaccurate unless the bot is running without any downtimes 24/7

🦭 Support & Security

If you have any questions or if you discover a security vulnerability within Cially, please join my Discord Server and let me know! I will try to assist you as soon as possible! Please do not publish publicly security vulnerabilities.

🍤 Contributing

Please open a PR for new features or issues you managed to fix! However keep the following in mind:

• Do not open pull requests regarding minor issues such as grammatical errors. Open an issue instead
• Do not sumbit "troll" or "spam" requests
• Do not rewrite a big part of the project in a single pull request

📜 License

This project is licensed under the Attribution-NonCommercial-NoDerivs 2.0 License

You are free to:

• Share — copy and redistribute the material in any medium or format
• Adapt — remix, transform, and build upon the material The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

• Attribution — You must give appropriate credit , provide a link to the license, and indicate if changes were made . You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
• NonCommercial — You may not use the material for commercial purposes . -** No additional restrictions** — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

Created by Skell! Please leave a ⭐ if you like this project and want to see more features!