Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Latest commit

 

History

History
161 lines (102 loc) · 3.91 KB

README.md

File metadata and controls

161 lines (102 loc) · 3.91 KB
Raw

EddieBot

The official EddieBot for the EddieHub Discord server. Join us at Discord today!

Open EddieBot in Gitpod

Features

  • Checking peoples' messages for inclusive language.

Eddie bit warning

Config / Secrets environment variables

Copy .env.example to .env and add your private information

Note: never commit this file, it is ignored by Git

# .env file

# required: discord API token
DISCORD_TOKEN=

# required: mongo URL connection string
EDDIEBOT_MONGO_CONNECTION_STRING=

# optional
DEBUG_HOOK=

# required: discord server id
HOME_GUILD="699608417039286293"

# optional
NODE_ENV="development"

# required: channel id for logs
ADMIN_CHANNEL=

Installation

1. Start by making a fork of the repository. Click on the "Fork" symbol at the top right corner.

2. Clone your new fork of the repository:

SSH Github Docs

$ git clone [email protected]:EddieHubCommunity/EddieBot.git

note: recommended

GitHub CLI

$ gh repo clone EddieHubCommunity/EddieBot

HTTPS

$ git clone https://github.com/EddieHubCommunity/EddieBot.git

3. Set upstream command:

git remote add upstream https://github.com/EddieHubCommunity/EddieBot.git

4. Navigate to the new project directory:

cd EddieBot

5. Create a new branch:

git checkout -b <branch-name>

6. Sync your fork or a local repository with the origin repository:

  • In your forked repository click on "Fetch upstream"
  • Click "Fetch and merge".

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

7. Make your changes to the source code.

8. Stage your changes and commit:

git add <filename>
git commit -m "<your-commit-message>"

9. Push your local commits to the remote repository:

git push origin <branch-name>

10. Create a Pull Request!

11. Congratulations! You've made your first contribution to EddieBot! 🙌🏼

Discord Docs

Running the app

$ npm ci

# development
$ npm run build
$ npm start

Running the tests

$ npm test

Support

EddieBot is an MIT-licensed open source project. It can grow thanks to the contributors and the community members. If you'd like to join them, feel free to make a pull request and we'll review it.

Stuck? Have any questions or comments? Join us on Discord and ask for help.

License

The EddieBot is licensed under the MIT license.

Thanks to all Contributors 💪

Thanks a lot for spending your time helping EddieBot grow. Thanks a lot! Keep rocking 🍻

Contributors

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read our Code of Conduct.