Skip to content

Commit

Permalink
0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
williamhorning committed Jul 6, 2023
1 parent c068151 commit 1223b13
Show file tree
Hide file tree
Showing 83 changed files with 4,790 additions and 5,584 deletions.
6 changes: 6 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
charset = utf-8
end_of_line = lf
indent_style = tab
insert_final_newline = true
root = true
trim_trailing_whitespace = true
9 changes: 7 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
.env
node_modules
!.env.example
.DS_Store
.env
.env.*
/config.ts
dist
output
11 changes: 10 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
{
"useTabs": true
"useTabs": true,
"printWidth": 80,
"endOfLine": "lf",
"arrowParens": "avoid",
"embeddedLanguageFormatting": "auto",
"proseWrap": "always",
"quoteProps": "as-needed",
"semi": true,
"singleQuote": true,
"trailingComma": "none"
}
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
deno 1.34.3
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"deno.enable": true,
"deno.lint": true,
"deno.unstable": true
}
8 changes: 8 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ARG DENO_VERSION=v1.34.3

FROM docker.io/lukechannings/deno:${DENO_VERSION}
VOLUME [ "/config" ]
WORKDIR /app
ADD ./packages/bolt /app
RUN deno cache /app/mod.ts
CMD [ "run", "-A", "--unstable", "mod.ts", "--", "run", "--config", "/data/config.ts"]
20 changes: 16 additions & 4 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
Copyright 2022 William Horning <hello@williamhorning.dev>
Copyright (c) William Horning <hey@williamhorning.dev> and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# bolt
## docs
looking for bolt docs? check out [the docs](/docs/README.md), this readme is for the bolt codebase itself.
## setup
### pre-requisites
- Node.js 19 or higher
- NPM 8 or higher
- MongoDB on localhost:27017
- A Discord, Revolt, and Guilded bot with the token and client ID accessible
### steps
1. Clone the repository
2. Run `npm install` to install dependencies
3. Setup `.env` to contain the following:
```sh
DISCORD_TOKEN = "token.goes.here"
DISCORD_CLIENTID = "clientid.goes.here"
GUILDED_TOKEN = "token.goes.here"
REVOLT_TOKEN = "token.goes.here"
ERROR_HOOK = "webhook.goes.here"
```
4. Run `node scripts/cli.js registerSlashCommands` to register the slash commands
5. Run `node scripts/cli.js run` to start the bot
# Bolt 0.5.0-beta

<img src="./branding/banner.png" height="50%">

---

## How to run this

**You don't,** if you want to have sanity by the end of the day. If you're fine
with losing your sanity, here's all the things you'll need:

- Deno 1.34.3 or higher with the unstable flag
- MongoDB 4 or higher
- Redis

Then, if you haven't died trying to figure all of that out, you'll need to
figure out which plugins you want to use.

## Platform feature support feature matrix thingy

Key: ✓ = supported, ~ = supported w/limitations, I = incomplete, T = todo, E =
eventually, X = not supported

| | text | threads | forums |
| ------------ | ---- | ------- | ------ |
| bolt-bridge ||| E |
| bolt-discord ||||
| bolt-guilded | ~ | T | E |
| bolt-matrix | ~ | E | X |
| bolt-revolt || X | X |
10 changes: 10 additions & 0 deletions TODO
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## todo list as of the 3rd

NO MORE BREAKING CHANGES AT THIS POINT

- docs site
- CI
- fix bolt-revolt as that's blocked by
https://github.com/revoltchat/revolt.js/issues/83
- work on https://github.com/discordjs/discord.js/issues/9645 after 0.5 releases
as it's not blocking
98 changes: 0 additions & 98 deletions app/bridge/bridge.js

This file was deleted.

28 changes: 0 additions & 28 deletions app/bridge/index.js

This file was deleted.

26 changes: 0 additions & 26 deletions app/bridge/legacyBridgeSend.js

This file was deleted.

101 changes: 0 additions & 101 deletions app/bridge/utils.js

This file was deleted.

Loading

0 comments on commit 1223b13

Please sign in to comment.