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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 593 by rakinar2, Sat Aug 3 16:15:12 2024 UTC revision 599 by rakinar2, Wed Aug 7 14:51:05 2024 UTC
# Line 55  Next, navigate to the directory where yo Line 55  Next, navigate to the directory where yo
55  cd sudobot  cd sudobot
56  ```  ```
57    
58    ### Building SudoBot for Node.js
59    
60  Now, to build the project, we'll use [BlazeBuild](https://github.com/onesoft-sudo/sudobot/tree/main/blazebuild), which is a blazingly fast build tool, for TypeScript and JavaScript projects.  Now, to build the project, we'll use [BlazeBuild](https://github.com/onesoft-sudo/sudobot/tree/main/blazebuild), which is a blazingly fast build tool, for TypeScript and JavaScript projects.
61  To use BlazeBuild, you don't need to install anything including BlazeBuild itself, as it will be installed and set-up automatically during the build process.  To use BlazeBuild, you don't need to install anything including BlazeBuild itself, as it will be installed and set-up automatically during the build process.
62  BlazeBuild will also make sure to install any missing SDKs or tools required for building the project.  BlazeBuild will also make sure to install any missing SDKs or tools required for building the project.
# Line 69  This will build, compile and package the Line 71  This will build, compile and package the
71  Depending on your system, the build process may take a few seconds to a few minutes to complete.  Depending on your system, the build process may take a few seconds to a few minutes to complete.
72  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.
73    
74  If you don't have enough resources, this command will 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 **v21**, however they should also work with **v20**.
75  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 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.
76  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest
77    
78  As always if you ever encounter errors with commands or you see something is not working as you expect, you can join our [Discord Server](https://discord.gg/892GWhTzgs) and ask for help!  As always if you ever encounter errors with commands or you see something is not working as you expect, you can join our [Discord Server](https://discord.gg/892GWhTzgs) and ask for help!
79    
80    ### Building SudoBot for Bun
81    
82    If you'd like to use Bun instead of Node.js to run SudoBot, then you don't need to build the bot because Bun supports TypeScript natively. Just skip to the next part and follow the commands and instructions specifically for Bun.
83    
84  ## Configuration  ## Configuration
85    
86  After building the project, you need to configure the bot to run on your server.  After building the project, you need to configure the bot to run on your server.

Legend:
Removed from v.593  
changed lines
  Added in v.599

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26