/[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 625 by rakinar2,
Fri Aug 30 10:10:15 2024 UTC
+revision 626 by rakinar2,
Sat Sep  7 09:38:45 2024 UTC
 Line 1
  ---
- title: Getting Started - SudoBot
+ title: Getting Started
  short_name: Getting Started
  ---
 Line 130 
 DB_URL=postgresql://username:password@ho
  # Replace `your-jwt-secret` with the generated secret.
  JWT_SECRET=your-jwt-secret
+ # The directory where the bot will store persistent data like
+ # configuration files, logs, and more.
+ SUDO_PREFIX=/path/to/sudobot/storage
  # Optionally, you can uncomment the following to turn on debug mode
  # to see more detailed logs, and enable certain development features.
-Line 146 
 The guild-wide configuration file is `co
+Line 150 
 The guild-wide configuration file is `co
  The files are located at `config/` in the project root. These configuration files don't contain any specific setting, they are just a starting point for you to configure the bot.
  You can edit these files to your liking.
+ Then, go to the `SUDO_PREFIX` directory, and copy the `config` directory to the `SUDO_PREFIX` directory.
+ This should also copy the `config.json` and `system.json` files to the `SUDO_PREFIX` directory, that you just edited.
+ **Remember, this step is important. Otherwise, any updates to the configuration files will be lost when you update the bot using Git.**
  To see all the possible configuration options, please refer to these schema files:
  - [Guild Configuration Schema](https://github.com/onesoft-sudo/sudobot/blob/main/src/main/typescript/schemas/GuildConfigSchema.ts)
-Line 233 
 If using Node:
+Line 242 
 If using Node:
  npm install -D
  ```
+ You might get an error saying something like `symlink(): Operation not permitted` &mdash; this is fine and you can safely ignore it.
  **Build the project (Skip this if using Bun)**
  ```bash
  npm run build
  ```
+ **Copy the resource files**
+ Please copy the following resources from `src` to `build`:
+ * `src/main/resources` should be copied to `build/out/main` and the name should still be `resources`
  **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:
-Line 265 
 Then run this file:
+Line 282 
 Then run this file:
  bun migrate.ts
  ```
+ If you'd like to use Node.js for this, then create a `migrate.js` file instead and paste the following:
+ ```javascript
+ require("dotenv/config");
+ async function main() {
+     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();
+ }
+ main();
+ ```
+ And run:
+ ```bash
+ node migrate.js
+ ```
  And if everything was correctly set up, your database will have the new tables created for SudoBot.
  **Starting the Bot**
-Line 297 
 In case if you're facing issues, feel fr
+Line 342 
 In case if you're facing issues, feel fr
  -   Email: [[email protected]](mailto:[email protected])
  -   Discord: [@rakinar2](https://discord.com/users/774553653394538506)
- -   Discord Servers: [Official OSN Server](https://discord.gg/JJDy9SHzGv)
+ -   Discord Servers: [Official OSN Server](https://sudobot.online/discord)
  Give the repository a star to show your support! We'll be really thankful if you do.

 Legend:



Removed from v.625
 


changed lines


 
Added in v.626
 Legend:



Removed from v.625
 


changed lines


 
Added in v.626
-Removed from v.625
+Added in v.626

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26