Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 3.13 KB
Raw

How to contribute to korean discord app

Requirements

  • Git
  • A text editor
  • Node.js
  • Knowledge of JavaScript and Discord.js

Install Git

Git is a source code management program to keep track of the different changes in the project. It's the tool we use to work together!

Download Git

Install a Text Editor

If you don't have a text editor we recommed installing Visual Studio Code

Install Node.js

Download Node.js LTS

Install forever

Download forever

(Optional) Create a DB on MongoDB Atlas or Install MoongoDB Community Server Locally

MongoDB Atlas
MongoDB Community Server

Documentation

Fork The Project

  • Create you own copy of the project

Set Up the Discord Bot

  • Create your own Discord server where you have admin access.
  • Create a new Discord app in the Discord Developer Portal. On the top right, click New Application and give it a name.
  • On the left side of the page, select Bot in the navigation bar and click Add Bot to create a new bot. Confirm.
  • In your forked repository, create a copy of the .env-sample file and rename the copy to .env.
    • Back in the Bot settings on the Discord Developer Portal website, copy your bot's Token and paste it after ACCESS_TOKEN= in your .env file.
    • Replace CLIENT_ID with the Client ID from your app found in the General Information settings.
    • Replace MOD_CHANNEL, CHAT_CHANNEL, LINKS_CHANNEL, KOREAN_CHANNEL,EXERCISES_CHANNEL with the ID of text channels in your new Discord server. To get them, right click on the text channel and click Copy ID
    • Replace SERVER_ID with your SERVER ID. To find it, right click on the server then go to Server Settings -> Widget and copy the SERVER ID
    • (If applicable) Replace Moderator with your server's moderator role. To find it, right click on the server then go to Server Settings -> Roles. Hover over the corresponding role and click the three dots that appear. Then click Copy ID.
    • (If applicable) Replace ACTIVE_ROLE with your server's active-members role. To find it, right click on the server then go to Server Settings -> Roles. Hover over the corresponding role and click the three dots that appear. Then Copy ID.
    • (If applicable) Replace DATABASE_URI with the URI of your MongoDB database.

Start the App

From the project folder run this command in your terminal:

npm start

Add Changes