Skip to content

Commit 106337c

Browse files
committed
2 parents 0db714b + 799868c commit 106337c

File tree

3 files changed

+247
-1
lines changed

3 files changed

+247
-1
lines changed

.github/workflows/sf-mirror.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Mirror to SourceForge
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
9+
jobs:
10+
sync:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
# Checkout GitHub repo with full history
15+
- name: Checkout repository
16+
uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0 # important! fetch all commits
19+
20+
# Set up SSH
21+
- name: Set up SSH
22+
run: |
23+
mkdir -p ~/.ssh
24+
echo "${{ secrets.SF_PRIVATE_KEY }}" > ~/.ssh/id_rsa
25+
chmod 600 ~/.ssh/id_rsa
26+
ssh-keyscan -t rsa git.code.sf.net >> ~/.ssh/known_hosts
27+
28+
# Add SourceForge remote
29+
- name: Add SourceForge remote
30+
run: git remote add sourceforge "ssh://[email protected]/p/bjh-os/code"
31+
32+
# Push all branches and tags
33+
- name: Push to SourceForge
34+
run: |
35+
git push sourceforge --all
36+
git push sourceforge --tags

DEV_DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1300,4 +1300,4 @@ This project is not affiliated with Microsoft or Windows. It is an Web Based Ope
13001300
---
13011301
**End of Developer Documentation**
13021302

1303-
For questions, issues, or contributions, please contact us on [Discord](https://discord.gg/SdDSUtCbX8)
1303+
For questions, issues, or contributions, please contact us on [Discord](https://discord.gg/SdDSUtCbX8)

README.md

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# 💻 BJH OS
2+
3+
Assalam O Alaikum everyone! 👋 My name is **Muhammad Haris** and I made a **web-based operating system** named **BJH OS** 🌐💡
4+
5+
**BJH OS** is a **browser-based operating system** developed using **pure HTML, CSS, and JavaScript** — no frameworks, no backend dependencies ⚙️🚫. It’s designed to give you the feel of a real desktop OS, but in your web browser 🖥️✨
6+
7+
---
8+
9+
## 🚀 Key Features
10+
11+
- 🖼️ **Custom Desktop Environment**
12+
Draggable, resizable windows with a familiar desktop layout. Apps now open inside movable, desktop-style windows with titlebars and close buttons. Windows can be maximized or restored by double-clicking the titlebar.
13+
- 🖱️ **Smoother UI & Window Management**
14+
Enhanced shadows, borders, and polished drag interactions give a modern desktop feel. Double-click the titlebar to maximize/restore windows, and enjoy smoother dragging and window interactions.
15+
16+
- 📦 **Built-in Apps**
17+
Includes File Manager, Notes, Chat App (*ChatLink*), Settings, and more. Start menu & toolbar apps now open inside windows instead of new tabs, providing a seamless desktop experience.
18+
19+
- 🧩 **Modular Architecture**
20+
Easily add new themes, wallpapers, and apps.
21+
22+
- 💾 **Persistent Data**
23+
Uses `localStorage` to save your preferences and data between sessions.
24+
25+
- 🧑‍💻 **Powerful Web Terminal**
26+
Run commands and control the OS with a built-in terminal — ideal for devs and power users.
27+
28+
- 🌐 **Remote Alerts & Update System**
29+
Displays alerts and updates fetched from a remote JSON config. Automatic notifications ensure you never miss an important update.
30+
31+
- 🤖 **BJH OS AI**
32+
Built-in assistant for smarter interactions and workflow automation.
33+
34+
- 🌐 **Flash Browser**
35+
Lightweight, fast, and secure browser integrated into BJH OS.
36+
37+
- 🌍 **Worldwide Rollout**
38+
Updates are being released globally in stages to ensure stability, avoid server overload, and provide a smooth installation experience.
39+
40+
41+
42+
43+
### 🎉 BJH OS Apps Market
44+
45+
The **BJH OS Apps Market** is included in the **BJH OS 4.7 update** and is released in phases to ensure smooth performance and prevent server overload.
46+
47+
---
48+
49+
### ✨ Main Features
50+
51+
- Browse all apps and games with a **search bar** and **autocomplete suggestions**.
52+
- Tabs for **Games**, **Apps**, and **Search**.
53+
- App display includes: **icon, name, category, rating, and number of downloads**.
54+
- Trending notifications at the top with app URL and main image.
55+
- App detail page shows:
56+
- Icon & name
57+
- Developer/company name
58+
- Rating and number of reviews
59+
- Download size and number of downloads
60+
- Download button
61+
- Screenshots and video previews
62+
- About this app/game description
63+
- Ratings & Reviews with “Was this review helpful?” counters
64+
- Similar apps or games at the bottom
65+
66+
---
67+
68+
### 👤 User Features
69+
70+
- **Login or create a BJH OS account** to use the Apps Market.
71+
- Manage favorite apps.
72+
- Downloads saved in **Manage Apps** panel.
73+
- **Download the latest apps and games**.
74+
- **Update apps automatically** when a new version is available.
75+
- Rate and review apps.
76+
- Reset or recover forgotten passwords.
77+
- Receive system and email notifications for registration and app updates.
78+
79+
---
80+
81+
### 💻 Developer Features
82+
83+
- Upload apps/games with: icon, name, description, screenshots/video, category, version, and zip file.
84+
- Upload updates for existing apps.
85+
- View app statistics: downloads, ratings, reviews.
86+
- Comment on user reviews.
87+
- Manage promotion points for app visibility.
88+
- Notifications panel for approvals and promotion updates.
89+
- Provide app support info: website, email.
90+
- Submit appeals if needed.
91+
92+
---
93+
94+
### 🔒 Security & UX
95+
96+
- Secure login for users and developers (password hashing, reset password).
97+
- Validation for file uploads (icons, videos, zip files).
98+
- Modern, beautiful, mobile-friendly UI.
99+
- Clear and intuitive navigation.
100+
101+
---
102+
103+
### 🌟 Extra Features
104+
105+
- Rating aggregation and visualization.
106+
- Review helpfulness tracking.
107+
- Trending apps notifications.
108+
- Smooth app promotion workflow with points system.
109+
- System emails for registration, app updates, and promotions.
110+
111+
---
112+
113+
### 📢 Rollout Updates
114+
115+
- Introduced in **BJH OS 4.7 update**.
116+
- Released in **phases** to reduce server overload and prevent crashes.
117+
- Users gradually gain access as the rollout progresses.
118+
- Updates and notifications sent via **BJH OS system notifications** and emails.
119+
120+
---
121+
122+
## 🛠️ How to Run BJH OS
123+
124+
1. ⬇️ **Download the ZIP** from the [BJH OS MAIN REPOSITORY](https://github.com/Haris16-code/BJH-OS)
125+
2. 🗂️ **Extract** the ZIP file
126+
3. Open the extracted `BJH-OS` folder
127+
4. 🖱️ **Double-click** the file named `Setup.html`
128+
5. 🌍 BJH OS will launch in your default browser
129+
130+
> 🧑‍💻 No installation required — just open and go!
131+
132+
---
133+
134+
## 🧰 BJH OS TOOL
135+
136+
To make managing BJH OS easier, I developed a Python-based utility called **BJH OS TOOL** 🐍🛠️
137+
It lets you:
138+
139+
- 📦 Install BJH OS updates
140+
- 🎮 Install apps and games
141+
- 🖼️ Install wallpapers and cursors
142+
143+
### 🖥️ BJH OS TOOL 64-Bit
144+
145+
- 🛠️ Install BJH OS Update: Extract the latest ZIP → Open BJH OS TOOL → Click "Install Update" → Select the extracted folder → Refresh BJH OS.
146+
- 🖱️ Install Cursor: Select `.svg` file → Refresh BJH OS.
147+
- 🖼️ Install Wallpaper: Select `.jpg` or `.png` image → Refresh BJH OS.
148+
- 🎮 Install Apps/Games: Select the app folder → Open from BJH OS home screen.
149+
150+
### 🖥️ BJH OS TOOL 32-Bit
151+
152+
- ▶️ Run Tool: Double-click to start.
153+
- 🛠️ Install Update: Provide the folder path for the update.
154+
- 🎯 Install Cursor: Provide full path to `.svg` file.
155+
- 🖼️ Install Wallpaper: Provide full path to image.
156+
- 📦 Install App: Provide the directory path containing `index.html`.
157+
158+
---
159+
160+
## 📁 General Notes on File Paths
161+
162+
- 🧭 **Absolute Path:** Full path from the root of the filesystem.
163+
- 🧮 **Relative Path:** Path relative to your current directory.
164+
165+
**Examples:**
166+
- Absolute: `C:\Users\YourName\Documents\myfile.jpg`
167+
- Relative: `.\Documents\myfile.jpg`
168+
169+
✅ Ensure the file or folder exists before proceeding.
170+
171+
---
172+
## 🧑‍💻 Developer Documentation
173+
174+
BJH OS 4.6 developer docs provide everything you need to **build, extend, and create apps or games** for the web-based desktop experience.
175+
176+
**Highlights:**
177+
- **Step-by-Step App & Game Development For BJH OS:** Learn how to create apps and games for BJH OS from scratch, including folder structure, required files, optional assets, and best practices.
178+
- **Project Structure:** Clear layout of core files and directories:
179+
- **Window & Taskbar Systems:** Full guidance on draggable, resizable windows, maximize/restore behavior, taskbar icons, and in-window app launching.
180+
- **App Models:** Supports both built-in apps (pre-installed) and 3rd-party apps (installed via BJH OS TOOL).
181+
- **App Folder Template & Installer Flow:** Proper folder setup with required files (`index.html`, `favicon.ico`) and optional files (`style.css`, `app.js`, `constants.js`, assets). Includes installer instructions for seamless integration into BJH OS.
182+
- **Font Sync & Theming:** Apps automatically inherit the system font using `localStorage.selectedFont`. Supports custom themes and styling.
183+
- **Examples Included:** Ready-to-use apps like **Calculator** and **Snake** demonstrate best practices for structure, styling, and functionality.
184+
- **API & Programmatic Launching:** Use `window.openAppInWindow(url, title)` for in-window app launches and intercept same-origin `window.open()` calls.
185+
- **Testing & Troubleshooting:** Checklist for responsiveness, offline support, console errors, and common fixes. Tips for performance optimization and user experience.
186+
- **Developer Guidance & Best Practices:** Code style, accessibility, packaging/sharing apps, contributor workflow, and submitting apps to the BJH OS ecosystem.
187+
188+
> For full instructions, examples, and detailed guidance:
189+
> 📄 **[Full Developer Documentation Here](DEV_DOCS.md)**
190+
191+
192+
## 💻 BJH OS Discord Community
193+
194+
Join the **BJH OS Community** on Discord and connect with fellow users, developers, and enthusiasts! 🎉
195+
**[Join Now!](https://discord.gg/SdDSUtCbX8)**
196+
197+
We are building an active community around **BJH OS**, where you can:
198+
199+
- Get help with installation and troubleshooting
200+
- Share feedback and suggestions
201+
- Upload apps or games for the BJH OS Apps Market
202+
- Chat with other BJH OS users and developers
203+
- Participate in events, contests, and discussions
204+
205+
Whether you are a **developer, tester, or BJH OS fan**, there’s a place for you here!
206+
207+
---
208+
**Made with love in Pakistan ❤️**
209+
---
210+
**© 2025 BJH OS — by Muhammad Haris**

0 commit comments

Comments
 (0)