https://github.com/solvro/backend-solvro-bot-core
Main repo for Solvro bot.
https://github.com/solvro/backend-solvro-bot-core
Last synced: 2 months ago
JSON representation
Main repo for Solvro bot.
- Host: GitHub
- URL: https://github.com/solvro/backend-solvro-bot-core
- Owner: Solvro
- License: agpl-3.0
- Created: 2025-04-10T20:21:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-26T09:24:56.000Z (4 months ago)
- Last Synced: 2026-02-26T15:07:46.740Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 711 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend Solvro Bot Core
[📂 GitHub Project](https://github.com/orgs/Solvro/projects/40) |
[👥 GitHub Team](https://github.com/orgs/Solvro/teams/solvro-bot) |
[💾 Google Drive](https://drive.google.com/drive/folders/1YeTG061qQ5Y9_eGXIXAa4POcpaZerIN5)
---
## Services
- [🎙️ Transcriber](https://github.com/Solvro/backend-solvro-bot-transcriber)
- [📹 Office Cam](https://github.com/Solvro/hardware-solvro-bot-office-cam)
---
## Development
### Prerequisites
- [Visual Studio Code](https://code.visualstudio.com/)
- [Node.js & npm / pnpm](https://nodejs.org/en/download)
- [Docker](https://www.docker.com/)
---
### Step-by-Step Guide
#### Install Project Dependencies
Recommended:
```bash
pnpm install
```
Alternatively:
```bash
npm install
```
#### Setup environment variables
```bash
node ace bootstrap:env
```
and set variables according to the comments.
#### Start Required Services
Ensure Docker Engine is running, then start all services:
```bash
docker compose up -d
```
> [!NOTE]
> To shut down all services, run:
> ```bash
> docker compose down
> ```
#### Migrate Database
Run all pending database migrations:
```bash
node ace migration:run
```
> [!NOTE]
> Check migrations status using:
> ```bash
> node ace migration:status
> ```
#### Run Application
Start the application:
```bash
pnpm dev
```
Alternatively:
```bash
npm run dev
```
You should see a message similar to this:
```bash
[ info ] starting HTTP server...
╭─────────────────────────────────────────────────╮
│ │
│ Server address: http://localhost:3333 │
│ Watch Mode: HMR │
│ Ready in: 5 ms │
│ │
╰─────────────────────────────────────────────────╯
```
---
### Commits
Follow the [Conventional Commits](https://www.conventionalcommits.org) specification.
> [!NOTE]
> The commit message should be structured as follows:
>
> ```
> [optional scope]:
>
> [optional body]
>
> [optional footer(s)]
> ```
---
### Visual Studio Code Extensions
> [!TIP]
> Press Ctrl + Shift + X and search _@recommended_ to see recommended Visual Studio Code extensions for this workspace.
### API Documentation
Documentation is auto-generated based on the [OpenAPI](https://www.openapis.org) specification using [AdonisJS AutoSwagger](https://github.com/ad-on-is/adonis-autoswagger).
> [!IMPORTANT]
> Navigate to [http://localhost:3333/docs](http://localhost:3333/docs) to access the [Scalar](https://scalar.com) UI, where you can explore the API endpoints interactively.
### Custom Commands
#### Bootstrap Environment Variables
```bash
node ace bootstrap:env
```
#### Deploy Discord Commands
Deploy registered commands to the Discord REST API:
```bash
node ace discord:deploy
```
> [!IMPORTANT]
> Use this command to deploy changes to the Discord API whenever you modify the command signatures (*SlashCommandBuilder*) in the *app/discord/commands* directory.
>
---
## Resources
### Discord.js
[library docs](https://discord.js.org/docs) |
[developer guide](https://discordjs.guide) |
[Discord docs](https://discord.com/developers/docs)
### AdonisJS
[docs](https://docs.adonisjs.com) |
[tutorials](https://adocasts.com)
Don't forget to check out [Solvro docs](https://docs.solvro.pl/)