Skip to content

Ajad-cpu/PixelCraft

Repository files navigation

PixelCraft

PixelCraft — a lightweight, privacy-first in-browser image editor. No uploads, no accounts, just fast local editing with layers, brushes and basic filters.

License [Static Site]


🚀 Quick start — get running in seconds

bash

1. Clone the repo

git clone https://github.com/Ajad-cpu/PixelCraft.git cd PixelCraft

2. Install dependencies

download npm and run npm install

3. Start the server

npm run server

Open http://localhost:8000 (or the port printed by your server) and start editing! 🎨


✨ About PixelCraft

PixelCraft is a small, open-source image editor built to run entirely in the browser — no uploads, no telemetry. It's perfect for quick edits, prototyping, teaching, or embedding a simple canvas editor inside another web app.

Key features

  • Layers and basic layer controls
  • Brush / paint tools and shape tools
  • Basic filters and adjustments
  • Drag-and-drop and clipboard paste support
  • Offline-friendly: service worker and static assets included

📂 Repo structure (high level)

  • index.html — single-page entry and demo UI
  • dist/ — built assets (if available)
  • images/ — screenshots and demo assets
  • examples/ — example files and demos
  • package.json & webpack.config.js — dev/build scripts

🛠 Development notes

  • The repo already contains static assets and a working index.html, so you can run it without Node.
  • If you want to modify build tooling, run npm install then npm run build (if present).

Helpful commands

bash npm install # install deps npm run dev # start development server (if provided) npm run build # build production assets (if provided)


🎯 Tips & customizations

  • Change UI styles by editing the CSS files in the repo.
  • Add auto-save using localStorage to persist canvases between reloads.
  • Export enhancements: add SVG export or better PNG metadata.
  • Add collaborative drawing with WebSockets (socket.io).

🐞 Troubleshooting

  • Blank page: Open DevTools → Console. Make sure index.html can load bundle.js (if present) and assets from the correct relative path.
  • npm run dev not found: The repo is primarily static; you can use a static server (see Quick start) or add a dev toolchain.
  • Port already in use: change the port when running the server: npm run server -- -p 9001.

🤝 Contributing

Contributions are welcome!

  1. Fork the repo
  2. Create a branch: git checkout -b feature/my-cool-tool
  3. Commit: git commit -m "feat: add "
  4. Push & open a PR

Please add screenshots or short GIFs for any UI changes.


📜 License

PixelCraft is released under the MIT License. See LICENSE for details.


💬 Contact

If you want help customizing this README or adding deployment (GitHub Pages / GitHub Actions), CI, or a Dockerfile, email: azadsinghdinkar@gmail.com.

Happy pixel-crafting! 🖌

About

About PixelCraft is an open-source, browser-based image editor designed for speed, simplicity, and privacy. It runs entirely in your browser with no installs or uploads required, offering powerful features like layers, filters, brushes, and drag-and-drop support. Whether you need quick edits, creative effects, or an embeddable Photoshop-style tool.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors