Skip to content

Latest commit

 

History

History
103 lines (78 loc) · 3.13 KB

README.md

File metadata and controls

103 lines (78 loc) · 3.13 KB

Coloring Book

A React application for creating personalized coloring books from imported or custom-created images.
Explore the docs »

Live Demo · Report Bug · Request Feature

Features ✨

  • Upload a book cover image
  • Import images and convert them into outlines for coloring.
  • Draw custom designs directly in the app.
  • Organize pages into a book format, ready for printing.
  • Simple and intuitive interface for all age groups.

Usage 📖

Upload an image to convert it into a coloring outline. Use the drawing tool to create custom designs. Arrange pages in the desired order. Download the final book as a PDF.

Stack 🧰

This project is built with the following technologies and tools:

  • TypeScript: For type-safe JavaScript development.
  • React: To build the user interface. Documentation referenced directly in the app - React Documentation.
    • Server API: For server-side rendering or data fetching.
    • Client API: For client-side interactions and components.
  • Vite: A fast and modern build tool - Learn more.
  • Tailwind CSS: For utility-first styling with rapid development.
  • GitHub Actions: For automated deployment workflows.
  • Supabase: Open source Firebase alternative Learn more.
  • Supabase-js: Learn more.

Installation 🛠️

  1. Clone this repository:

    git clone https://github.com/willahh/coloringbook.git
    cd coloringbook
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm start
    # Open your browser and navigate to http://localhost:3000.

Resources

Applications

Build and deployment

Build for production

  • frontend/readme.md#build
  • backend/readme.md#build

Deploy for production

  • frontend/readme.md#deploy
  • backend/readme.md#deploy

Acknowledgments 🙏

Inspired by the creative possibilities of coloring books. Thanks to open-source libraries and the developer community!

Contact

License

All Rights Reserved

Copyright (c) 2025 William Ravel