mirror of
https://github.com/ducbao414/win32.run.git
synced 2025-12-15 08:42:49 +09:00
Update README.md
This commit is contained in:
10
README.md
10
README.md
@@ -10,13 +10,13 @@ https://user-images.githubusercontent.com/5462728/218907749-22ddea15-8761-4cf3-b
|
||||
*Microsoft and Windows XP trademarks & logos definitely belong to Microsoft Corporation. All the programs' names and logos (Foxit, Word, WinRar, Internet Explorer, etc.) are of their rightful copyright holders. **win32.run** is purely for the **purpose of nostalgia**. I have no intent and no right to monetize **win32.run**, but you may occasionally see ads when playing third-party games.*
|
||||
|
||||
# Introduction
|
||||
### 💖 It's for nostalgia's sake!
|
||||
### 🦄 It's for nostalgia's sake!
|
||||
|
||||
**WIN32.RUN** runs solely on the client-side (the user's browser). All files are processed right in the user's browser. There is no file uploading, no server-side processing (cause I'm broke, can't afford it). Each user has his own OS session (just like the good old Windows XP)
|
||||
|
||||
Files (and Folders) in win32.run are stored locally in IndexedDB. Apps (and 3rd-party apps) can interact with files through win32.run homemade file picker and saver dialog (with Windows XP appearance).
|
||||
# Built with
|
||||
WIN32.RUN is built with [Svelte](https://github.com/sveltejs/svelte)/[SvelteKit](https://github.com/sveltejs/kit) and [Tailwindcss](https://github.com/tailwindlabs/tailwindcss).
|
||||
🔥 WIN32.RUN is built with [Svelte](https://github.com/sveltejs/svelte)/[SvelteKit](https://github.com/sveltejs/kit) and [Tailwindcss](https://github.com/tailwindlabs/tailwindcss).
|
||||
If you come from a React or Vue background, Svelte is really easy to work with. It doesn't have much boilerplate.
|
||||
|
||||
Writing webapps in Svelte is just like writing vanilla JS, with ```div``` tag for UI and ```script``` tag for logic. One can pick it up in under an hour.
|
||||
@@ -24,14 +24,14 @@ Writing webapps in Svelte is just like writing vanilla JS, with ```div``` tag fo
|
||||
The downside is *surprised breaking changes*.
|
||||
|
||||
# Run, build & deploy
|
||||
I deploy it on a $5 Vultr instance, so there's no special hardware and dependencies requirement here, except Node.js (and NPM).
|
||||
I deploy it on a $5 Vultr instance, there's no special hardware and dependencies requirement here, except Node.js (and NPM).
|
||||
|
||||
The project is built with [Svelte](https://github.com/sveltejs/svelte), which may not be great at backward-compatibity at its current phase. You probably don't want to update Svelte and SvelteKit to newer versions to keep things working.
|
||||
## 📦 Install dependencies
|
||||
Clone or download from Github
|
||||
```shell
|
||||
git clone https://github.com/ducbao414/win32.run.git
|
||||
cd win32.run
|
||||
cd win32.run-main
|
||||
```
|
||||
Then install dependencies
|
||||
```shell
|
||||
@@ -54,7 +54,7 @@ npm run preview
|
||||
## Deploy
|
||||
I shamelessly share my deployment process.
|
||||
|
||||
Follow [this guide](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-20-04) to set up a Ubuntu server with NGINX. I chose Vultr cause theirs is cheaper than DigitalOcean ($5 vs $6).
|
||||
Follow [this guide](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-20-04) to set up a Ubuntu server with NGINX. I chose Vultr since theirs is cheaper than DigitalOcean's ($5 vs $6).
|
||||
|
||||
Put the build folder, package.json, package-lock.json on to the server, ```cd``` then ```npm install```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user