Open Sketch - Your Creative Canvas

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

Introduction

Welcome to Open Sketch! This is a versatile and user-friendly sketching application that empowers you to explore your creativity on a digital canvas. Whether you're an artist, designer, or just looking to express yourself, Open Sketch provides the tools you need.

Features

🚧 We are at early development stage, every contribution of every type will be welcome and properly attributed.

Sketch Book Manager

• Multi-Language
• Open New Sketch Books
• Open Existing Sketch Books
• Portable Sketch Book format

Painting Canvas

• Static size painting canvas
• Background Color (Experimental)
• Background Image

Drawing Palette

• "Pen" Brush
• "Pencil" Brush
• "Eraser" Brush
• Brush Color
• Recent used brush color palette
• Brush Size
• Store Drawing settings

Sketch Book

• Create Default Sketch Book
• Add new Sketch to the Sketch Book
• Remove Sketch from the Sketch Book
• Add Sketch navigator inside Sketch Book
• Re-order sketches in a Sketch Book (Drag and drop)

Export Sketches

• Add Export to PNG (Experimental)
• Add Export to PNG, WEBP, JPG..

Edit Sketches

• Undo/Redo - CtrlOrCmd+Z

Getting Started

Prerequisites

Before you begin, ensure you have the following:

• Operating System: Open Sketch is compatible with Windows, macOS, and Linux.

• Hardware: A computer or tablet with a compatible input device (mouse, stylus, or touchpad) for drawing.

Installation

• Download: Visit our Release Page to download the latest version of Open Sketch for your platform.

• Installation: Follow the installation instructions for your operating system.

Usage

• Launch: Open Sketch and create a new canvas or open an existing project.

• Drawing: Use the drawing tool to sketch, paint, and design to your heart's content.

• Export: When your masterpiece is ready, export it in your preferred format or share it with others.

For more detailed instructions and tips, check out our User Guide.

Contributing

We welcome contributions from the community! Whether you're a developer, designer, or have ideas for improvements, please see our Contribution Guidelines for details on how to get involved.

Install project for development

Requirements

• PHP 8.2 or higher
• NODE v20.8 or higher
• Composer PHP package manager
• Yarn JS/TS package manager

Installation guide

Clone the project

git clone git@github.com:kpicaza/open-sketch.git

Install dependencies

cd open-sketch
cp .env.example .env
composer install
yarn

Run app in development mode

yarn dev

Open another console

php artisan native:serve

Run tests

composer check-all

Currently, NativePHP doesn't allow enabling PHP extensions. At this time, to manipulate images, we need to install the GD extension for image manipulation. Until this feature is available in NativePHP, we can compile our own PHP and substitute it for the original one in vendor/nativephp/php-bin. It is only required to Download Sketch feature. Every other feature will work as expected with default PHP binary packed by NativePHP.

License

This project is licensed under the BSD-3-Clause License. You are free to use, modify, and distribute this software as long as you adhere to the terms of the license.