Backend Solvro Bot Core

📂 GitHub Project | 👥 GitHub Team | 💾 Google Drive

---

Services

• 🎙️ Transcriber
• 📹 Office Cam

---

Development

Prerequisites

• Visual Studio Code
• Node.js & npm / pnpm
• Docker

---

Step-by-Step Guide

Install Project Dependencies

Recommended:

pnpm install

Alternatively:

npm install

Setup environment variables

node ace bootstrap:env

and set variables according to the comments.

Start Required Services

Ensure Docker Engine is running, then start all services:

docker compose up -d

Note

To shut down all services, run:

docker compose down

Migrate Database

Run all pending database migrations:

node ace migration:run

Note

Check migrations status using:

node ace migration:status

Run Application

Start the application:

pnpm dev

Alternatively:

npm run dev

You should see a message similar to this:

[ info ] starting HTTP server...
╭─────────────────────────────────────────────────╮
│                                                 │
│    Server address: http://localhost:3333        │
│    Watch Mode: HMR                              │
│    Ready in: 5 ms                               │
│                                                 │
╰─────────────────────────────────────────────────╯

---

Commits

Follow the Conventional Commits specification.

Note

The commit message should be structured as follows:

<type>[optional scope]: <description>

[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 specification using AdonisJS AutoSwagger.

Important

Navigate to http://localhost:3333/docs to access the Scalar UI, where you can explore the API endpoints interactively.

Custom Commands

Bootstrap Environment Variables

node ace bootstrap:env

Deploy Discord Commands

Deploy registered commands to the Discord REST API:

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 | developer guide | Discord docs

AdonisJS

docs | tutorials

Don't forget to check out Solvro docs

_{Built with 💙 by Solvro}