Skip to content

Commit da6e57b

Browse files
yousumohamedyousumohamed
committed
Prepare release: update build scripts, docs, and config
1 parent 16419c3 commit da6e57b

File tree

17 files changed

+391
-125
lines changed

17 files changed

+391
-125
lines changed

‎.github/workflows/monaco-editor.yml‎

Lines changed: 0 additions & 100 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ product.overrides.json
2323
*.tsbuildinfo
2424
.vscode-test
2525
vscode-telemetry-docs/
26+
launch_error.txt
27+
run_log.txt
28+
electron_log.txt

‎BUILD_AND_UPDATE.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 📦 Building and Updating Som DVPS
2+
3+
## 1. **Build the Release (Best for Friends)**
4+
5+
This creates the fast, optimized version.
6+
7+
1. **Run:**
8+
```cmd
9+
build_release.bat
10+
```
11+
2. **Wait** 15-20 minutes.
12+
3. **Find it:** `.build/vscode-win32-x64-min/`
13+
4. **Send it:** Zip the folder inside and send it.
14+
15+
---
16+
17+
## 2. **How to Update (Icons, Code, Name)**
18+
19+
If you change an icon, the name, or any code, you must **REBUILD**.
20+
21+
### **Step 1: Make your changes** (e.g., replace `resources/win32/code.ico`)
22+
23+
### **Step 2: Clean the old build** (Important!)
24+
```cmd
25+
npm run gulp clean
26+
```
27+
28+
### **Step 3: Rebuild the Release**
29+
```cmd
30+
build_release.bat
31+
```
32+
33+
### **Step 4: Send the New Version**
34+
Zip the new output and send to your friends. They should delete their old folder and use the new one.
35+
36+
---
37+
38+
## ⚡ **Quick Reference**
39+
40+
| Action | Command |
41+
|ws|ws|
42+
| **Test changes quickly (Dev)** | `npm run compile` then `npm run electron` |
43+
| **Build final version (Release)** | `build_release.bat` |
44+
| **Clean everything (Reset)** | `npm run gulp clean` |
45+
46+
---
47+
48+
### 🎨 Changing the Icon (Example)
49+
1. Replace `c:\code\vscode\resources\win32\code.ico` with your new icon.
50+
2. Run `npm run gulp clean`
51+
3. Run `build_release.bat`
52+
53+
Done!

‎HOW_TO_RUN.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,3 @@ That's it! Just 3 steps:
7373
Your Som DVPS will launch! 🎉
7474

7575

76-
git init
77-
git add .
78-
git commit -m "first commit"
79-
git branch -M main
80-
git remote add origin https://github.com/yousumohamed/Som-Dvps-Code1.git
81-
git push -u origin main --force

‎LICENSE.txt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Som DVPS End User License Agreement
2+
3+
Copyright (c) 2026 Som DVPS Team
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10+
11+
Privacy Policy
12+
-------------
13+
Som DVPS respects your privacy. This application does not collect personal data without your consent.
14+
For more details, please visit our website.

‎README.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Som DVPS 🚀
2+
3+
**Som DVPS** is a custom, high-performance code editor built on the robust core of Visual Studio Code. This repository contains the source code, build scripts, and customization tools to build, run, and distribute your own version.
4+
5+
---
6+
7+
## 🛠️ Step 1: Prerequisites (Critical)
8+
9+
Before you do anything, you **MUST** have these specific versions installed.
10+
11+
### 1. Node.js (v20.x or v22.x)
12+
You need a recent version of Node.js. The project is tested with **v22.21.1**.
13+
* **Direct Download (Windows x64 MSI):** [Download Node.js v22.21.1](https://nodejs.org/dist/v22.12.0/node-v22.12.0-x64.msi)
14+
* **Verify installation:**
15+
```cmd
16+
node -v
17+
```
18+
*(Output should be `v20.x.x` or `v22.x.x`)*
19+
20+
### 2. Visual Studio 2022 Build Tools
21+
You need the Microsoft C++ compiler to build the native modules used by the editor.
22+
* **Direct Download Installer:** [vs_buildtools.exe](https://aka.ms/vs/17/release/vs_buildtools.exe)
23+
* **Installation Instructions:**
24+
1. Run the installer.
25+
2. Select **"Desktop development with C++"** workload.
26+
3. On the **right side**, ensure these specific components are checked:
27+
* ✅ **MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest)**
28+
* ✅ **Windows 11 SDK (10.0.xxxxx.x)**
29+
* ✅ **C++ CMake tools for Windows**
30+
* ✅ **MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs** (Optional, but recommended to avoid warnings)
31+
32+
### 3. Python
33+
* Install Python 3 from the [Microsoft Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K) or [python.org](https://www.python.org/downloads/).
34+
35+
---
36+
37+
## 📥 Step 2: Clone & Install
38+
39+
1. **Clone the repository:**
40+
```cmd
41+
git clone https://github.com/yousumohamed/Som-Dvps-Code1.git
42+
cd Som-Dvps-Code1
43+
```
44+
45+
2. **Run the automated installer:**
46+
We have created a special script that handles all the complex setup for you.
47+
```cmd
48+
.\install_som_dvps.bat
49+
```
50+
* *This script sets strict build flags and installs all NPM dependencies.*
51+
* *Wait for it to finish. If it succeeds, you are ready!*
52+
53+
---
54+
55+
## 🏃‍♂️ Step 3: How to Run
56+
57+
There are two ways to run the app depending on what you are doing.
58+
59+
### ⚡ Option A: "Just Run It" (Fastest)
60+
Use this if you just want to launch the editor and use it.
61+
```cmd
62+
npm run som-dvps
63+
```
64+
* **What it does:** Launches the pre-compiled version of the app immediately.
65+
66+
### 🧑‍💻 Option B: "Developer Mode" (Watch Changes)
67+
Use this if you are editing the source code (JS/TS files) and want to see changes live.
68+
69+
1. Open **Terminal 1** and run:
70+
```cmd
71+
npm run watch
72+
```
73+
*(This starts the incremental compiler. Wait for it to quiet down.)*
74+
75+
2. Open **Terminal 2** and run:
76+
```cmd
77+
npm run som-dvps
78+
```
79+
*(Now, if you change a file, Terminal 1 will recompile it, and you can reload Terminal 2 to see changes.)*
80+
81+
---
82+
83+
## 📦 Step 4: How to Build a Release (.exe)
84+
85+
Ready to share **Som DVPS** with the world? You can build a professional installer.
86+
87+
1. **Close all running instances** of Som DVPS.
88+
2. Run the build script:
89+
```cmd
90+
.\build_release.bat
91+
```
92+
3. **Wait patiently.** This process takes **15-20 minutes**.
93+
* It cleans old files.
94+
* It compiles and minifies the code (runs `gulp minify`).
95+
* It builds the Windows executables.
96+
* It creates a Setup Installer.
97+
98+
### 🎉 Where is my Installer?
99+
Once the script says **"Build Complete!"**, look in these folders:
100+
101+
* **The Installer (Share this file):**
102+
`C:\code\vscode\.build\win32-x64\system-setup\VSCodeSetup.exe`
103+
*(Rename this to `SomDVPS_Setup.exe` before sharing!)*
104+
105+
* **The Zippable Folder:**
106+
`C:\code\vscode\.build\win32-x64\Som DVPS-win32-x64\`
107+
108+
---
109+
110+
## 🔧 Troubleshooting & Customization
111+
112+
### How to Change the Icon?
113+
1. Replace the file `resources\win32\code.ico` with your own `.ico` file.
114+
2. Run `build_release.bat` to bake it into the `.exe`.
115+
116+
### "Spectre-mitigated libraries are required" Error?
117+
1. Open **Visual Studio Installer**.
118+
2. Click **Modify** on your Build Tools.
119+
3. Go to **Individual Components**.
120+
4. Search for "Spectre".
121+
5. Check **MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)**.
122+
6. Click **Modify** to install.
123+
124+
### How to Change the Name?
125+
1. Open `product.json`.
126+
2. Edit `nameShort`, `nameLong`, and `applicationName`.
127+
3. Rebuild using `build_release.bat`.
128+
129+
---
130+
**Som DVPS Team** - *Built for Developers, by Developers.*

‎RUN_SOM_DVPS.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 🚀 Som DVPS - FINAL SIMPLE GUIDE
2+
3+
## ✅ How to Run Som DVPS
4+
5+
### **Single Command:**
6+
```cmd
7+
cd c:\code\vscode
8+
npm run electron
9+
```
10+
11+
**That's it!** Som DVPS will launch with "Som DVPS" in the title bar.
12+
13+
---
14+
15+
## 📝 After Making Code Changes
16+
17+
```cmd
18+
# 1. Recompile
19+
npm run compile
20+
21+
# 2. Launch
22+
npm run electron
23+
```
24+
25+
---
26+
27+
## 🎯 Quick Start Script
28+
29+
I've created `run_som_dvps.bat` for you. Just double-click it or run:
30+
```cmd
31+
run_som_dvps.bat
32+
```
33+
34+
---
35+
36+
## ✅ What's Working Now
37+
38+
- ✓ Window title shows "Som DVPS"
39+
- ✓ All features work
40+
- ✓ Your custom editor is ready!
41+
42+
The executable is still called "code-oss.exe" internally, but users see "Som DVPS" everywhere that matters (window title, menus, etc.).
43+
44+
---
45+
46+
## 🎨 To Fully Rebrand (Optional)
47+
48+
If you want the .exe file itself to be called "Som DVPS.exe", you need to build a distributable:
49+
50+
```cmd
51+
npm run gulp vscode-win32-x64
52+
```
53+
54+
This creates a full installer in `.build/win32-x64/` with everything branded as "Som DVPS".
55+
56+
---
57+
58+
**Your Som DVPS is ready to use!** 🎉
59+
60+
Just run: `npm run electron`

‎SECURITY.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)