ThongCoder commited on
Commit
6179a48
·
verified ·
1 Parent(s): 3857f85

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -23
README.md CHANGED
@@ -6,34 +6,63 @@ colorTo: indigo
6
  sdk: docker
7
  pinned: true
8
  license: mit
9
- short_description: An online VS Code, now equipped with compilers.
10
  ---
11
 
12
- # VS Code on the Web IDE with Auto Backup
13
 
14
- This Space runs **VS Code on the Web** with:
15
- - Python 3.12
16
- - C++ (gcc, g++)
17
- - Git
18
- - Node.js (JavaScript)
19
- - C# (Mono + .NET SDK 8)
20
- - Java (OpenJDK 17)
21
 
22
- ### Auto Backup
23
- Every 45 minutes, `/workspace` is automatically uploaded to your Hugging Face repo defined in env:
24
 
25
- - `BACKUP_REPO` target repo (e.g. `username/my-backup`)
26
- - `HF_TOKEN` your HF API token
 
 
 
 
 
 
27
 
28
- Files are uploaded using a cache-safe trick to avoid LFS errors.
29
 
30
- ### Usage
31
- 1. Set secrets in Space Settings:
32
- - `BACKUP_REPO`
33
- - `HF_TOKEN`
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
- Please note:
36
- - Leaving any of these secret empty will not start the Auto Backup Service and will *not* restore the last version.
37
- - All files will be wiped clean on Space restart. It is **recommended** for you to have Persistent storage space, or a private data store repo on HF with the secrets correctly set.
38
- 2. Launch Space → Access VS Code on port 7860.
39
- 3. Work normally, backups run in the background.
 
6
  sdk: docker
7
  pinned: true
8
  license: mit
9
+ short_description: An online VS Code on the Web, now equipped with toolchains.
10
  ---
11
 
12
+ # 💻 VS Code on the Web IDE with Auto Backup
13
 
14
+ This Space runs **VS Code on the Web** with a **full developer toolchain**, ready for mega collaboration:
 
 
 
 
 
 
15
 
16
+ ### 🔧 Installed Developer Tools
 
17
 
18
+ - **Python 3.12**: pip, virtualenv, JupyterLab, `black`, `flake8`, `mypy`, IPython
19
+ - **C/C++**: gcc, g++, clang, lld, cmake, ninja, valgrind, gdb
20
+ - **Rust**: stable toolchain via rustup
21
+ - **Go**: latest stable
22
+ - **Java**: OpenJDK 17
23
+ - **C#/.NET**: .NET SDK 8.0
24
+ - **Node.js 20**: npm, yarn, pnpm, TypeScript, ts-node, nodemon
25
+ - **CLI Productivity Tools**: git, git-lfs, htop, fzf, ripgrep, silversearcher-ag, rsync, sqlite3, tree, jq, net-tools, and *even* sqlite3.
26
 
27
+ This container is designed to handle **Python, Rust, Go, Node, Java, C#, C/C++**, and more — all in one robust online IDE.
28
 
29
+ ---
30
+
31
+ ### 🗂️ Auto Backup
32
+
33
+ Every 45 minutes, `/workspace` is automatically uploaded to your Hugging Face repo defined in environment variables:
34
+
35
+ - `BACKUP_REPO` → target repo (e.g., `username/my-backup`)
36
+ - `HF_TOKEN` → your Hugging Face API token
37
+
38
+ > ⚠️ On first launch, the backup service will attempt to restore `/workspace` from your `BACKUP_REPO`. Make sure the repo exists. If empty, a fresh workspace will be created.
39
+
40
+ Files are uploaded using a **cache-safe method** to avoid LFS errors.
41
+
42
+ ---
43
+
44
+ ### 🚀 Usage
45
+
46
+ 1. Set secrets in **Space Settings**:
47
+ - `BACKUP_REPO`
48
+ - `HF_TOKEN`
49
+
50
+ **Notes**:
51
+ - Leaving either secret empty will **disable Auto Backup** and restore.
52
+ - All files are wiped on Space restart. Using a private repo is highly recommended.
53
+
54
+ 2. Launch the Space → Access VS Code at `http://<space-url>:7860`
55
+ - No authentication by default (`--auth none`).
56
+ - Optional: enable a password via environment variables if desired.
57
+
58
+ 3. Work normally — backups run in the background every 45 minutes.
59
+
60
+ ---
61
+
62
+ ### ⚡ Quick Commands Cheat Sheet
63
 
64
+ **Python:**
65
+ ```bash
66
+ python3 myscript.py
67
+ pip install <package>
68
+ jupyter lab