Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation scripts for Linux (PM2/Docker) and Windows (Docker Desktop) #263

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

cookieauth
Copy link
Contributor

@cookieauth cookieauth commented Nov 2, 2024

Pull Request for SudoBot

Thank you for contributing to SudoBot! Please fill out the sections below to provide context and ensure a smooth review process.


Type of Change

Please select the type of change your PR introduces:

  • Bug fix
  • New feature
  • Enhancement
  • Documentation update
  • Refactoring
  • Other (describe below)

Description

Provide a concise description of what this pull request does. Include relevant information about the problem it solves, new features added, or improvements made.

Description:

This PR adds 3 scripts that is designed to ease the installation process across multiple OS's and platforms.


Related Issues

Does this pull request address any existing issues? If so, please list them:

  • Closes NONE
  • Related to NONE

Checklist

Please confirm that your pull request meets the following requirements:

  • I have followed the SudoBot Contribution Guidelines.
  • I have tested my changes to ensure they work as expected.
  • My code follows the code style of this project.
  • I have added relevant documentation (if applicable).
  • I have updated tests or added new tests where necessary.

Additional Notes (Optional)

Add any additional context, information, or screenshots here if applicable.


Thank you for your contribution! 🎉

A script to automatically install SudoBot on Linux using the PM2 process manager with user input.

Signed-off-by: cookieauth <github@mail.cookieauth.com>
Signed-off-by: cookieauth <github@mail.cookieauth.com>
Signed-off-by: cookieauth <github@mail.cookieauth.com>
Signed-off-by: cookieauth <github@mail.cookieauth.com>
Signed-off-by: cookieauth <github@mail.cookieauth.com>
Signed-off-by: cookieauth <github@mail.cookieauth.com>
…s.ps1

Signed-off-by: cookieauth <github@mail.cookieauth.com>
Copy link

vercel bot commented Nov 2, 2024

@cookieauth is attempting to deploy a commit to the OSN Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

netlify bot commented Nov 2, 2024

Deploy Preview for sudobot-api-docs ready!

Name Link
🔨 Latest commit 8843034
🔍 Latest deploy log https://app.netlify.com/sites/sudobot-api-docs/deploys/6726606aee01dc0008339ad2
😎 Deploy Preview https://deploy-preview-263--sudobot-api-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Nov 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.18%. Comparing base (fe90ff2) to head (8843034).
Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #263   +/-   ##
=====================================
  Coverage   6.18%   6.18%           
=====================================
  Files        376     376           
  Lines      35411   35411           
  Branches     847     847           
=====================================
  Hits        2191    2191           
  Misses     32960   32960           
  Partials     260     260           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: cookieauth <github@mail.cookieauth.com>
@github-actions github-actions bot added the type:docs Improvements or additions to documentation label Nov 2, 2024
Copy link
Member

@Ryanmello07 Ryanmello07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for Rakin's review.

Copy link
Member

@virtual-designer virtual-designer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks great! Except I'd like to make one thing clear: We already have a tool called BlazeBuild, that works great on Linux, I think it should work on Windows as well by now. BlazeBuild handles the automatic installation of Bun/Node.js and all these things. If you've used Gradle, you'd be familiar with BlazeBuild. Gradle and BlazeBuild are very similar. There's a ./blazew script, which is the BlazeBuild Wrapper, just like Gradle wrapper.
For the PM2 script, we can just create a new BlazeBuild task in build_src/main/typescript, and it can invoke PM2 to start the bot.
Other scripts look fine to me. Let me know what do you think about this, and if you think not doing it this way might be a good idea.

}

# Function to install PM2
install_pm2() {
Copy link
Member

@virtual-designer virtual-designer Nov 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you didn't know, SudoBot already comes with PM2 (take a look at the package.json file). Instead of global install, running npm install or bun install in the project root installs pm2 as well. Then you can run npx pm2 or bunx pm2 to execute PM2 commands.

Signed-off-by: cookieauth <github@mail.cookieauth.com>
@ninsaccplayzyt
Copy link
Member

While this is an amazing idea, we already have BlazeBuild for this as Rakin (virtual-designer) has said. While this would be awesome to add for users, potentially helping them, I'm not sure if it will be useful with now having BlazeBuild. In the end, this would be up to Rakin (virtual-designer) to decide if this added or not.

I am aware this is 2 weeks old now, but I've only just seen it, and wanted to give my opinion on this.

@virtual-designer
Copy link
Member

While this is an amazing idea, we already have BlazeBuild for this as Rakin (virtual-designer) has said. While this would be awesome to add for users, potentially helping them, I'm not sure if it will be useful with now having BlazeBuild. In the end, this would be up to Rakin (virtual-designer) to decide if this added or not.

I am aware this is 2 weeks old now, but I've only just seen it, and wanted to give my opinion on this.

Yeah, and no changes were made in the past 2 weeks that fixes the issues I highlighted. So I'm afraid we can merge this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:medium type:build type:docs Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

4 participants