Skip to content

Automated installation#85

Merged
WhyPenguins merged 6 commits intothoth-tech:mainfrom
jessbdeakin:automate_install
Sep 26, 2024
Merged

Automated installation#85
WhyPenguins merged 6 commits intothoth-tech:mainfrom
jessbdeakin:automate_install

Conversation

@jessbdeakin
Copy link
Contributor

Description

Introduces a Python script and a routine in the Node.js server script, both of which will download the files necessary to run SplashKit Online. The Node.js routine will only run if none of the files to be downloaded are present. The README file has also been updated to account for this simpler way in which to install SKO.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation (update or new)

How Has This Been Tested?

I have tested it by removing all relevant files and then either 1) running the Python script, or 2) starting the Node.js server, and then examining the file tree to ensure everything is present.

Testing Checklist

  • Tested on Windows
  • Tested on Mac
  • Tested on Linux

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

Potential Issues

  • May be tedious to maintain parity between Python script and Node.js setup.
  • Modifications to server.js to work around async design are ugly at best.

@UberNomad
Copy link
Contributor

Looks good – instructions were clear, everything installed correctly, and I was able to compile and run.

Copy link

@Liquidscroll Liquidscroll left a comment

Choose a reason for hiding this comment

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

Overall this looks pretty good to me! Tested both setup.py and setup.js and they work as expected.

One small issue regarding the commands listed in README.md.

README.md Outdated
```
However, we also need to import the SplashKit library, as its not included in the repository by default. The Node server will import the necessary files automatically on start-up, but this can also be achieved with the included `setup.py` script.
```bash
py setup.py # optional

Choose a reason for hiding this comment

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

This should probably be changed to python3 setup.py as py is not present on all OS's -- For example, this command does not work in WSL2.

It could also be explained that this command should be run from the root of the project, as the following command npm run server must be run from the Browser_IDE folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the note. I was unsure which tool name was the canonical one.

Copy link

@Liquidscroll Liquidscroll left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@WhyPenguins WhyPenguins merged commit 7a7bc8c into thoth-tech:main Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants