🌐 Afordin Web Stats

A dynamic dashboard showcasing key metrics of the Comuafor Discord community to track engagement and activity! 📊

Figma Design · Report a bug

📚 Table of Contents

• 🌐 Afordin Web Stats
  • 📚 Table of Contents
  • 🌟 Features
  • 🚀 Getting Started
    • 📦 Building for Production
    • 🔍 Preview Production Build
  • 🤝 Contributing to a project
  • Expanding the ESLint configuration
  • 👥 Authors
  • 🛠️ Stack

🌟 Features

• 📊 Interactive dashboard displaying key server metrics
• 💬 Track message counts, active users, and popular channels
• ⏰ Identify peak activity hours and engagement trends
• 🏆 View user leaderboards and most-used reactions

🚀 Getting Started

1. clone or fork this repository

   git clone /~https://github.com/Afordin/beerdin-front.gitt

2. install dependencies

   pnpm install

3. install husky hooks

   pnpm prepare

4. run the project

   pnpm run dev

📦 Building for Production

To create a production-ready build:

# Using pnpm
pnpm build

🔍 Preview Production Build

To preview the production build locally:

# Using pnpm
pnpm preview

🤝 Contributing to a project

1. Cloning a fork: Click on the fork button at the top right corner of the repository to create a copy of the project in your GitHub account.
2. Clone the Repository: Clone your forked repository to your local machine using the command (git clone <fork URL>) in your terminal.
3. Set upstream branch: To keep your forked repository updated with the original repository, use the command (git remote add upstream <repository original URL>).
4. Create branch: (git checkout -b feature/some-feature).
5. Stage the changed files: by using git-add to incrementally "add" changes to the index before using the commit command (git add <file>).
6. Record changes to the repository: Create a new commit containing the current contents of the index and the given log message describing the changes(git commit -m 'feat: some feature').

Some commit verbs and message good practices:

Verbs:

• feat (feature)
• fix (bug fix)
• docs (documentation)
• style (formatting, missing semi colons, …)
• refactor
• test (when adding missing tests)
• hotfix
• remove
• ci (For ci/cd changes)
• perf (performance the app)
• add (install a new depency or files, prefer 'feat' if you are adding a feature)
• update (update dependecies or files, prefer 'refactor' if you are refactoring a feature)

Message:

• just as in use imperative, present tense: “change” not “changed” nor “changes”
• don't capitalize first letter
• no dot (.) at the end

7. Submit your Contribution: Upload your branch with the changes to forked repository on GitHub using (git push origin feature/some-feature).
8. Generate a request: To complete the process of creating your PR, simply hit pull request

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

• Configure the top-level parserOptions property like this:

export default tseslint.config({
  languageOptions: {
    // other options...
    parserOptions: {
      project: ['./tsconfig.node.json', './tsconfig.app.json'],
      tsconfigRootDir: import.meta.dirname
    }
  }
});

• Replace tseslint.configs.recommended to tseslint.configs.recommendedTypeChecked or tseslint.configs.strictTypeChecked
• Optionally add ...tseslint.configs.stylisticTypeChecked
• Install eslint-plugin-react and update the config:

// eslint.config.js
import react from 'eslint-plugin-react';

export default tseslint.config({
  // Set the react version
  settings: { react: { version: '18.3' } },
  plugins: {
    // Add the react plugin
    react
  },
  rules: {
    // other rules...
    // Enable its recommended rules
    ...react.configs.recommended.rules,
    ...react.configs['jsx-runtime'].rules
  }
});

---

👥 Authors

Thanks to all the contributors who have made this project possible!

Frontend

Backend

🛠️ Stack

Made with ❤️ by comuafor 🐀