https://github.com/meese-os/meeseos

meeseOS, a highly modded fork of OS.js with a unique spin.
https://github.com/meese-os/meeseos

hacktoberfest os osjs portfolio webos window-manager

Last synced: about 1 month ago
JSON representation

meeseOS, a highly modded fork of OS.js with a unique spin.

• Host: GitHub
• URL: https://github.com/meese-os/meeseos
• Owner: meese-os
• License: other
• Created: 2020-09-06T16:18:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T06:35:13.000Z (4 months ago)
• Last Synced: 2024-09-01T10:56:38.012Z (4 months ago)
• Topics: hacktoberfest, os, osjs, portfolio, webos, window-manager
• Language: JavaScript
• Homepage: https://aaronmeese.com
• Size: 50.5 MB
• Stars: 11
• Watchers: 2
• Forks: 5
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

    

    

  








  

    

  

  

    

  

	

		

	



This redesign of my website would not be possible without the _incredible_ work by [Anders Evenrud](https://github.com/andersevenrud) on [OS.js](https://github.com/os-js/OS.js). As you can see in the majority of the files, this monorepo is a modified amalgamation of the OS.js source code.

## Setup

- Run the following commands and update the generated files with your own information:

	- `cp apps/old-site/.env.template apps/old-site/.env`

	- `cp apps/terminal/scripts/.env.template apps/terminal/scripts/.env`

	- `cp website/src/client/.env.template website/src/client/.env`

	- `cp website/src/server/auth/template.env.json website/src/server/auth/.env.json`

- `bash ./scripts/setup.sh`

## Deploy

- `bash ./scripts/deploy.sh`

  - Can use `--no-reset` for local deployment testing, so you don't lose your changes

- Running `pm2 monit` will allow you to track when the server has finished initializing

For more information, see [this guide](https://manual.os-js.org/guide/deploy/).

## Troubleshooting

If you encounter the error `EADDRINUSE, Address already in use` on Windows, run `taskkill /F /IM node.exe`.

To see if the port is already in use on Linux, run `netstat -tulpn | grep LISTEN`. If you need to free the port, you can likely run `sudo pkill -9 node`. Alternatively, you can run the command `sudo fuser -k 8000/tcp` until there is no output, then the port will be guaranteed to be free.

To see if your process is still runninng, run `pm2 list`.

To monitor the logs from your process, run `pm2 monit`.

## Development

### Actions

To run GitHub Actions locally, do the following:

#### Linux

1. `curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash`

2. `sudo ./bin/act -s GITHUB_TOKEN=ENTER_YOUR_PAT_HERE`

3. Select "Medium" as the image size

#### Windows

1. `winget install nektos.act`

2. Open a new terminal

3. Ensure that Docker Desktop is running

4. `docker pull catthehacker/ubuntu:act-latest`

5. `act --pull=false -s GITHUB_TOKEN=ENTER_YOUR_PAT_HERE`

6. Select "Medium" as the image size

### Publishing

To publish changes to MeeseOS, use the following command:

```sh

rush --debug publish --publish --include-all --set-access-level public

```

You can specify which registry you want to publish by adding one of the following flags:

- GitHub Packages: `--registry https://npm.pkg.github.com`

- NPM: `--registry https://registry.npmjs.org`

If you want to do a dry run first, run `rush publish --include-all`.

# TODO

- Caching for "rush-project.json"

  - "Project does not have a rush-project.json configuration file, or one provided by a rig, so it does not support caching."

  - "rush build --verbose"