Skip to content

Project Structure

Here we can see a quick overview of the project structure.

  • Directory.github github templates and settings
    • DirectoryISSUE_TEMPLATE
      • bug_report.md
      • feature_request.md
    • FUNDING.yml github sponsors
    • PULL_REQUEST_TEMPLATE.md
  • Directorydocs/ documentation source code
  • Directorysrc/ chatbot source code
  • .gitignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • PREVIEW.gif
  • README.md

Chatbot

Here we can see a quick overview of the bot structure.

  • Directorysrc
    • bot.py main bot file
    • commands.py command handlers
    • config.py environment variables loader
    • greetings.py greetings module
    • pride.py pride module
    • suppress.py suppress utility
  • .env environment variables
  • Pipfile python dependencies
  • Procfile heroku deployment settings

Documentation

Here we can see a quick overview of this documentation structure.

  • Directorydocs
    • Directorypublic public assets
      • favicon.svg
    • Directorysrc
      • Directoryassets/ images and other assets
      • Directorycontent documentation routing
        • Directorydocs pages content
          • Directoryguides
            • project-structure.mdx this current page
          • Directoryreference/
          • Directoryresources/
          • index.mdx home page file
    • astro.config.mjs astro configuration
    • package.json node.js dependencies