Skip to content

luzli312/PixPaint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

109 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎨PixPaint

📓 Table of Contents

📌 About the Project

📜 Summary

PixPaint is a simple Java based pixel drawing app that lets anyone start creating pixel art within seconds on a 32x32 grid canvas. The app works on both Windows and MacOS.

  • Why we built it: We wanted to make a lightweight drawing tool that is easy to understand and saves work online, so you can pick up where you left off on any device.
  • What problem it solves: Many art tools are complicated and overwhelming. PixPaint is fast and beginner-friendly; it ensures your work is safely stored in the cloud and easy to retrieve.

🌟 Features

  • 🖌️ Brush Tool: Draw pixel-by-pixel with your selected colour
  • 🧽 Eraser Tool: Removes pixels instantly
  • ☁️ Save to MongoDB: Store your work under your account and reload it anytime
  • 📁 Load from MongoDB: Pick up from exactly where you left off
  • 💾 Export to PNG: Save your finished artwork locally
  • 👤 User Accounts: Log in to your account to access your artworks
  • 🚀 Easy to Use: Clean interface that can be used by both beginners and experts

📝 How to Use

  1. Log in/Sign up to your account.
    Screenshot 2025-08-14 at 12 11 25 PM
  2. Draw your art piece, using the brush/eraser tool. Change the palette's color by rightclicking on the color tiles. Screenshot 2025-08-14 at 12 20 19 PM Screenshot 2025-08-14 at 12 12 59 PM
  3. Export your finished art piece as a PNG!
    bunny

🌠 Authors

🛠️ Installation

  1. Create a MongoDB Account. Get your MongoDB connection string.
  2. Clone the repository.
    git clone https://github.com/luzli312/PixPaint.git
    cd PixPaint
    
  3. Set up MongoDB token.
    • In the project folder, create a file named: token.txt
    • Paste your account's MongoDB connection string inside it.
  4. Open the project in IntelliJ. If prompted, set the Project SDK to Java 17 or higher.
  5. Click the Run button after navigating to src/main/java/app/Main.java

Common Issues & Fixes

Issue Cause Fix
Package view does not exist IntelliJ did not set the src/main/java folder as the source root. Right-click src/main/javaMark Directory as → Sources Root.
Cannot connect to MongoDB Wrong token or network issue. Verify the contents of token.txt and network connection.

⚠️ License

This project is licensed under the MIT License.

📢 Feedback

Send feedback via our Google Form.

Feedback Guidelines:

  • Be clear and constructive.
  • Include steps to reproduce bugs that you witnessed.
  • Avoid spam or offensive language please.

🤝 Contributing

🗒️ How to Contribute

Contributions are always welcome! Follow the steps below.

Forking the project:

  1. Go to PixPaint repository on GitHub.
  2. Click the Fork button on the top-right corner to create your own copy.
  3. Clone your fork to your local machine:
    git clone https://github.com/your-username/PixPaint.git
    cd PixPaint
    

Making your Changes

  1. Create a branch of your changes.
    git checkout -b feature/your-feature
    
  2. Make your edits in the codebase.
  3. Commit your changes with a clear message.
    git commit -m "Descriptive message."
    
  4. Push your branch to your fork.
    git push origin feature/your-feature
    
  5. Submit a merge request (pull request) with your changes.

☑️ Guidelines for Good Merge Request

  • Keep requests focused on one feature or bug fix at a time.
  • Follow the existing code style (naming conventions, comments, etc.)
  • Test your changes to make sure it works
  • If your request changes the UI, add screenshots in the PR description.

🔍 Merge Review Protocol

  • At least one author will review your PR once it is submitted.
  • Feedback will be provided if any changes are needed.
  • PRs that meet all guidelines and pass tests will be merged into the main branch.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages