Skip to content

dawidolko/Windows-Simulaing-System-GUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪟 windows.dawidolko.pl

A React-powered personal portfolio that looks and feels like Microsoft Windows 10

Build Website Status Stars

Live Demo: https://windows.dawidolko.pl


📑 Table of Contents

  1. About
  2. Project Structure
  3. Star History
  4. Getting Started
  5. Customization Guide
  6. Contributing
  7. License & Author

About

windows.dawidolko.pl is a customisable portfolio website that recreates the Windows 10 desktop experience entirely in the browser.
Under the hood it’s a standard React + JavaScript SPA, but on the surface it behaves like a miniature OS: draggable windows, a start menu, themed apps, wallpapers and more. Use it as a portfolio, résumé, or playful landing page. 🖱️🖥️


Project Structure

SIMULAING-WINDOW...
├─ .github/                GitHub Actions & issue templates
│  ├─ ISSUE_TEMPLATE/
│  └─ workflows/
├─ node_modules/           Runtime dependencies
├─ public/                 Static assets served at /
│  ├─ android-chrome-*.png
│  ├─ apple-touch-icon.png
│  ├─ favicon*.png|ico
│  ├─ index.html           Main HTML shell
│  ├─ manifest.json        PWA manifest
│  └─ worker.js            Service-worker
├─ src/                    Application source
│  ├─ assets/              Images & fonts
│  ├─ components/          Re-usable React components
│  ├─ containers/          Page-level components
│  ├─ theme/               Global styles & variables
│  ├─ utils/               Helper functions & configs
│  ├─ App.*                Root component & styles
│  ├─ index.*              App entry point
│  └─ serviceWorker.js     PWA service worker registration
├─ .gitignore
├─ LICENSE                 MIT
├─ package*.json           NPM metadata & scripts
└─ README.md               You are here!

Star History

Star History Chart


Getting Started

Prerequisites

Installation

# 1. Clone the repo
git clone https://github.com/dawidolko/Windows-Simulaing-System-GUI
cd Windows-Simulaing-System-GUI/

# 2. Install dependencies
npm install     # or pnpm / yarn

# 3. Start the dev server
npm start

Production build

npm run build   # outputs an optimised bundle in /build

Tip (WSL users) If you’re on Windows Subsystem for Linux, you might need an X-server or the Windows Node runtime. See Microsoft’s guide: https://aka.ms/wslg.


Customization Guide

  1. User profile Edit src/utils/data/user.config.js with your name, avatar, social links, etc.

  2. App list & sidebar Toggle built-in apps or the left sidebar in src/utils/data/apps.config.js.

  3. Wallpapers Add images to public/wallpapers/ (create the folder if missing) and reference them in apps.config.js.

  4. Analytics (optional) Disable or enable Google Analytics / Firebase in src/utils/data/project.config.js.

  5. Firebase keys (only if analytics is on) Create a .env file at the project root:

    REACT_APP_APIKEY=...
    REACT_APP_AUTH_DOMAIN=...
    REACT_APP_DATABASE_URL=...
    REACT_APP_PROJECT_ID=...
    REACT_APP_STORAGE_BUCKET=...
    REACT_APP_MESSAGING_SENDER_ID=...
    REACT_APP_APP_ID=...
    REACT_APP_MEASUREMENT_ID=...
  6. EmailJS (optional contact form)

    REACT_APP_EMAILJS_KEY=your_emailjs_key

Contributing

Contributions are what make open source amazing! If you spot a bug 🐞, want a new feature ✨, or simply improve the docs:

  1. Fork the project
  2. Create your branch git checkout -b feat/awesome-feature
  3. Commit your changes git commit -m "Add awesome feature"
  4. Push the branch git push origin feat/awesome-feature
  5. Open a Pull Request

License & Author

Made with ❤️, ☕ and a nostalgic love for the Windows 10 aesthetic.

About

A portfolio website based on the theme of Windows 10.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published