/[sudobot]/trunk/docs/app/(docs)/getting-started/page.mdx

Diff of /trunk/docs/app/(docs)/getting-started/page.mdx

Parent Directory | Revision Log | View Patch Patch

-revision 601 by rakinar2,
Wed Aug  7 14:51:05 2024 UTC
+revision 602 by rakinar2,
Tue Aug 20 09:29:23 2024 UTC
 Line 17 
 This guide will help you get started wit
  ## Prerequisites
+ <Callout type="warning">
+     This guide assumes you have a Linux/Unix-based system where you'll install SudoBot. Windows users, please [scroll down](#windows-compatibility) to see how you can run SudoBot on Windows.
+ </Callout>
  Before you start, you need to have the following installed on your system:
  - A Discord API Application token (bot token). Go to the [Discord Developer Portal](https://discord.com/developers/applications) to create a new application, and get the token.
-Line 71 
 This will build, compile and package the
+Line 75 
 This will build, compile and package the
  Depending on your system, the build process may take a few seconds to a few minutes to complete.
  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.
- If you don't have enough memory, this command might fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v21**, however they should also work with **v20**.
+ If you don't have enough memory, this command might fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v22**, however they should also work with **v20** and **v21**.
  You might see that only Linux and macOS (darwin) releases are available. This doesn't mean you cannot run the bot on Windows systems - only the native bindings are platform dependent. You don't need to worry about that in most cases and the bot will just work fine.
  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest
-Line 209 
 To force the bot to clear the commands g
+Line 213 
 To force the bot to clear the commands g
  ./blazew run -- -c -g
  ```
+ ## Windows Compatibility
+ SudoBot was created with Linux/Unix-based systems in mind, since in most cases you're going to end up running SudoBot on a production server which is usually Linux/Unix-based.
+ However, that doesn't mean you can't run SudoBot on Windows &mdash; but please keep in mind that some things might need tweaks or you might need to do some things differently to make it work on Windows.
+ **First of all**, BlazeBuild on Windows is still experimental, known to have some issues. So please run the following commands as alternatives:
+ **Install dependencies**
+ ```bash
+ bun install
+ ```
+ If using Node:
+ ```bash
+ npm install -D
+ ```
+ **Build the project (Skip this if using Bun)**
+ ```bash
+ npm run build
+ ```
+ **Run the Database Migrations**
+ Please first make sure you have the right credentials in your `.env` file. Then, create a new file named `migrate.ts` in the project root with the following contents:
+ ```typescript
+ import "dotenv/config";
+ const { drizzle } = await import(String("drizzle-orm/node-postgres"));
+ const { migrate } = await import(String("drizzle-orm/node-postgres/migrator"));
+ const { Pool } = await import(String("pg"));
+ const pool = new Pool({
+     connectionString: process.env.DB_URL
+ });
+ const db = drizzle(pool);
+ await migrate(db, { migrationsFolder: "drizzle" });
+ await pool.end();
+ ```
+ Then run this file:
+ ```bash
+ bun migrate.ts
+ ```
+ And if everything was correctly set up, your database will have the new tables created for SudoBot.
+ **Starting the Bot**
+ Be sure to set up the configuration files before starting the bot! After doing that, run the following:
+ ```bash
+ bun dev
+ ```
+ Or, if using Node:
+ ```bash
+ npm run start
+ ```
+ Also note, to pass any options that you could pass to `./blazew run`, you can just pass it normally to `bun dev` if using `bun`, or after a `--` argument if using `npm run start`.
  ## Emojis
  The bot uses some custom emojis and it will try to find those emojis in the Home Guild (The main server, which is configured in `HOME_GUILD_ID` environment variable).

 Legend:



Removed from v.601
 


changed lines


 
Added in v.602
 Legend:



Removed from v.601
 


changed lines


 
Added in v.602
-Removed from v.601
+Added in v.602

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26