Skip to content

Latest commit

 

History

History
57 lines (50 loc) · 2.49 KB

README.md

File metadata and controls

57 lines (50 loc) · 2.49 KB

Parity

Parity is a discord bot made for Chingu Pair Challenges

How to run

  1. npm install to install dependencies
  2. Set up environment variables:
    • Create an .env file in the root directory of your project.
    • Add the following environment variables to .env file:
      Token and Client ID can be found in the Discord Developer Portal
      DISCORD_TOKEN = <your-discord-token>
      CLIENT_ID = <your-client-id>
      GUILD_ID = <your-server-id>
      LOBBY_VOICE_CHANNEL_ID = <your-lobby-voice-channel-id>
      VOICE_HUB = <your-voice-hub-id>
      TEXT_CHANNEL_ID = <your-text-channel-id>
      AIRTABLE_BASE_ID = <your-airtable-base-id>
      AIRTABLE_API_KEY = <your-airtable-api-key>
      AIRTABLE_TABLE_NAME_SESSIONS = <your-airtable-table-name-sessions>
      AIRTABLE_TABLE_NAME_CHALLENGES = <your-airtable-table-name-challenges>
      DEVELOPER_ROLE_ID = <your-developer-role-id>
      DATA_SCIENTIST_ROLE_ID = <your-data-scientist-role-id>
      UI_UX_DESIGNER_ROLE_ID = <your-ui-ux-designer-role-id>
      SCRUM_MASTER_ROLE_ID = <your-scrum-master-role-id>
      PRODUCT_OWNER_ROLE_ID = <your-product-owner-role-id>
  3. node index.js to run the bot
  4. When new commands are added, run node deploy-commands.js. This will update the server with the new changes. Only needed regarding commands. As of right now, this bot has no commands, so it's not neccessary to use.

Dev server

  1. npm run dev to start development server

Dependencies

  • airtable - ^0.12.2
  • discord.js - ^14.15.3
  • dotenv - ^16.4.5

Dev Dependencies

  • nodemon - ^3.1.4

Development

Branch naming

  • lowercase and hyphen inplace of space. For example feature/discord-bot
  • Only alphanumeric characters, dont use period, space, underscores etc. and dont use multiple hyphens after another, or trailing hyphens.
  1. feature/ for all features.
  2. bugfix/ for all bugfixes.
  3. hotfix/ for all quick emergency fixes.
  4. docs/ for udates to documentation.
  5. refactor/ for refactoring.

Commit messages

  • all commit messages should be short (50 characters or less), but descriptive. Example feat: add admin dashboard The description should also be what the commit does, not what you did. Notice the example above said add not added
  • We use the following prefixes:
    • feat: for features
    • fix: for bugfixes and hotfixes
    • docs: for ducumentaion
    • refactor: for refactoring