- About
- Local Development
- Showcase
- Tech Stack
- Features
- Privacy Policy and Terms
- Acknowledgements
- License
Pixie is a cozy pixel coloring game built for the web. It lets users explore pixel art templates, color them directly in the browser, listen to relaxing lo-fi music, and publish their own pixel templates.
The project is composed of a React frontend, a Spring Boot backend, and a PostgreSQL database, all integrated with Docker.
Requirements:
- Docker
- Docker Compose
If you'd like to run the project locally, clone this repository to your local environment or download the project files:
git clone https://github.com/enzzoMs/Pixie.git
Navigate to the main project directory:
cd ./Pixie
Create a .env file in the project root based on .env.example, replace the default values to configure PostgreSQL and the application.
cp .env.example .env
Start the development environment
docker compose --profile dev up --watch
Open the application
- Frontend: http://localhost:5173
- Backend: http://localhost:8080
- Swagger UI: http://localhost:8080/docs/swagger-ui.html
- Java
- Spring Boot
- Spring Web MVC
- Spring Security + JWT
- Spring Data JPA + Flyway
- OpenAPI / Swagger
- Maven
- Pixel Coloring Canvas: Color pixel-art templates directly in the browser.
- Integrated Lo-Fi Music Player: Listen to built-in lo-fi music while coloring templates.
- PNG Artwork Export: Export completed pixel artwork as PNG images directly from the application.
- Community Gallery: Public gallery where users can discover and explore pixel-art templates shared by the community.
- User Registration and Login: User authentication using JWT-based security for protected actions and personalized features.
- Template Progress Saving System: Save coloring progress and continue unfinished artwork at any time.
- Template Like System: Like and unlike templates to interact with community creations and keep track of favorites.
- Template Publishing: Upload and publish original pixel-art templates for other users to color.
- OpenAPI Documentation: Backend REST endpoints are documented using OpenAPI / Swagger for easier API exploration and testing.
- Docker Development Environment: Run the full application stack using Docker and Docker Compose for simplified setup and development.
Pixie includes separate documents for app usage and privacy information:
Pixie includes sample pixel templates and music tracks credited through their original authors and source URLs where available.
This project is distributed under the MIT License. Check the LICENSE file for more details.