https://github.com/turtlepaw/beep-boop

Just some Discord bot that'll help you with some things.
https://github.com/turtlepaw/beep-boop

Last synced: 3 days ago
JSON representation

Just some Discord bot that'll help you with some things.

• Host: GitHub
• URL: https://github.com/turtlepaw/beep-boop
• Owner: Turtlepaw
• License: mit
• Created: 2022-10-09T21:46:11.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T15:12:03.000Z (2 months ago)
• Last Synced: 2024-09-08T18:04:47.958Z (2 months ago)
• Language: TypeScript
• Homepage: https://bop.trtle.xyz
• Size: 36.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        






    


    🔎 bop.trtle.xyz

    



Beep Boop

Beep Boop is a Discord bot designed for use in large community servers.



### Notices

- **🔎 We need help!** We're looking for beta testers willing to test the bot for bugs, [sign up here](https://bop.trtle.xyz/beta).

- **🧪 Dashboard is in a experimental state:** Many dashboard pages haven't been completed, and they are extremely unstable.

- **🚧 Unstable and limited API:** The API hasn't been tested yet, and there are limited public and internal routes available.

### Welcome

Welcome to Beep Boop's Github repository, here you'll find all the source to Beep Boop.

### Contributing Guidelines

- Make sure to use our custom classes (e.g. `Selector`, `Filter`, etc...) found in [`src/utils`](https://github.com/Turtlepaw/beep-boop/blob/37dea1b4eec22005c7d67835f7fb91964729dc59/src/utils).

### Website Guidelines (wip)

- ~~Always show if the user has no JavaScript enabled.~~ (this hasn't been added yet)

- The branding pages should use little or no JavaScript.

### Software Requirements

- Yarn (3.4.1 or latest)

- Node.js (18.13.0 or latest)

## Styling Code and Files

### Comments

Add a space after the `//` so that your comments look nice!

```ts

// Here's a comment

```

## Files & Directories

We're trying to keep file naming consistent, although some files aren't consistent. When creating a new file start off with an uppercase, like this:

```

-> MyDirectory

    -> DirectoryUtils.ts

```

### Upcoming Changes

Here's the internal roadmap and the public roadmap.

- [Public Roadmap](https://www.craft.do/s/JJVExvuEq3ftaw)

- [Internal Roadmap](https://www.craft.do/s/ervTJxSCzWR0cZ)

### Official Discord Server

[![](http://invidget.switchblade.xyz/Rgxv5M6sq9)](https://discord.gg/Rgxv5M6sq9)