https://github.com/rsxgamerz/botway
https://github.com/rsxgamerz/botway
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/rsxgamerz/botway
- Owner: RSxGamerz
- License: mit
- Created: 2023-06-13T07:16:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T11:17:28.000Z (over 1 year ago)
- Last Synced: 2025-01-19T08:25:45.926Z (3 months ago)
- Language: TypeScript
- Size: 7.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
> **🤖 Generate, build, handle and deploy your own bot with your favorite language, for Discord, or Telegram, or Slack, or even Twitch.**
With botway, you can focus on your bot's logic and don't worry about the infrastructure. and we will take care of the rest.
Botway uses [Railway][rw] and [Render][rnd] to host your bot code and database.
## Requirements
- [**Railway Account**][rw]
- [**Render Account**][rnd]
## Installation ⬇
### Using script
- Shell
```bash
curl -sL https://dub.sh/botway | bash
```
- PowerShell
```powershell
irm https://dub.sh/bw-win | iex
```
**then restart your powershell**
### Homebrew
```
brew install abdfnx/tap/botway
```
### Scoop
```
scoop bucket add botway https://github.com/abdfnx/botway
scoop install botway
```
## Usage
- Initialize `~/.botway`
```bash
botway init
```
- Authenticate with your favorite host service
```bash
# railway
botway login railway
# render
botway login render
```
- Open Botway TUI
```bash
botway
```
- Create a new botway project
```bash
botway new
```
- Manage your bot tokens
```bash
botway tokens [flags]
```
- Start running your bot
```bash
# Under the project directory
botway start
```
- Manage your bot database
```bash
# Under the project directory
botway database
```
- Deploy and upload project from the current directory
```bash
# Under the project directory
botway deploy
```
- Execute a local command using variables from the active environment
```bash
# Under the project directory
botway exec
```
## Roadmap
> You can see the [**Roadmap**](https://github.com/users/abdfnx/projects/10)
## Keyboard shortcuts
- Up: **Move up**
- Down: **Move down**
- Tab: **Switch windows**
- Ctrl+O: **Open bot project at Host Service**
- Esc: **Reset**
- Ctrl+Q: **Quit**
### Technologies Used in Botway
- [**Railway API**][rw]
- [**Render Rest API**][rnd]
- [**Charm**](https://charm.sh)
- [**Cobra**](https://github.com/spf13/cobra)
- [**Viper**](https://github.com/spf13/viper)
- [**GJson**](https://github.com/tidwall/gjson)
- [**Termenv**](https://github.com/muesli/termenv)
- [**Boa**](https://github.com/elewis787/boa)
## Special thanks ❤
Thanks to [**@charmbracelet**](https://github.com/charmbracelet) for their awesome TUI libraries 🏗.
Also thanks to [**@railwayapp**](https://github.com/railwayapp) and [**@renderinc**](https://github.com/renderinc) for their amazing cloud and host services ☁️.
### License
botway is licensed under the terms of [MIT](https://github.com/abdfnx/botway/blob/main/LICENSE) license.
## Star History
[](https://star-history.com/#abdfnx/botway)
[rw]: https://railway.app
[rnd]: https://render.com