Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/callmeechocodes/eider
:thread: The extra fluff on Discord that you never knew you needed
https://github.com/callmeechocodes/eider
bot discord discord-api discord-bot discord-js typescript
Last synced: 4 months ago
JSON representation
:thread: The extra fluff on Discord that you never knew you needed
- Host: GitHub
- URL: https://github.com/callmeechocodes/eider
- Owner: CallMeEchoCodes
- License: mit
- Created: 2021-08-06T21:44:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-22T00:27:45.000Z (over 2 years ago)
- Last Synced: 2023-03-05T01:20:35.729Z (almost 2 years ago)
- Topics: bot, discord, discord-api, discord-bot, discord-js, typescript
- Language: TypeScript
- Homepage:
- Size: 150 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Table of Contents
## About The Project
Eider is a discord bot i made because i couldnt find a (good) open source [Carl-Bot](https://carl.gg/) alternative.
Eider is nowhere near done but i hope it can provide some use to you guys making bots. Feel free to steal my code just try to credit me
### Built With
* [Typescript](https://www.typescriptlang.org)
* [Discord.js](https://discord.js.org/)
## Getting Started
### Prerequisites
* pnpm
```sh
npm install pnpm -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/CallMeEchoCodes/Eider.git
```
2. Install Dependencies
```sh
pnpm i
```
3. Fill out `src/config.json`
```json
{
"token":"DISCORD_BOT_TOKEN",
"clientID":"DISCORD_BOT_USERID",
"guildID":"DISCORD_GUILD_ID"
}
```
4. Build the bot
```sh
pnpx tsc
```
5. Change Directory
```sh
cd ./dist
```
6. Run `Deploy.ts`
```sh
node ./Deploy.js
```
7. Run the bot!
```sh
node ./index.js
```
## Roadmap
See the [open issues](https://github.com/CallMeEchoCodes/Eider/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
[](https://discord.com/users/379035005231300608)
Project Link: [https://github.com/CallMeEchoCodes/Eider](https://github.com/CallMeEchoCodes/Eider)
## Acknowledgments
* [llsc12](https://github.com/llsc12) for helping me in my early discord bot making days
[contributors-shield]: https://img.shields.io/github/contributors/CallMeEchoCodes/Eider.svg?style=for-the-badge
[contributors-url]: https://github.com/CallMeEchoCodes/Eider/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/CallMeEchoCodes/Eider.svg?style=for-the-badge
[forks-url]: https://github.com/CallMeEchoCodes/Eider/network/members
[stars-shield]: https://img.shields.io/github/stars/CallMeEchoCodes/Eider.svg?style=for-the-badge
[stars-url]: https://github.com/CallMeEchoCodes/Eider/stargazers
[issues-shield]: https://img.shields.io/github/issues/CallMeEchoCodes/Eider.svg?style=for-the-badge
[issues-url]: https://github.com/CallMeEchoCodes/Eider/issues
[license-shield]: https://img.shields.io/github/license/CallMeEchoCodes/Eider.svg?style=for-the-badge
[license-url]: https://github.com/CallMeEchoCodes/Eider/blob/master/LICENSE
