Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
53 lines (35 loc) · 1.66 KB

CONTRIBUTION.md

File metadata and controls

53 lines (35 loc) · 1.66 KB
Raw

Contributing to Calcont Whiteboard 🎨

Welcome to Calcont Whiteboard ! We're thrilled that you're considering contributing to our project. Whether you're a seasoned developer or just starting out, there are plenty of opportunities to get involved. I have setup a roadmap to manage task status so if you are new to this project I"ll strongly suggest to go through that.
Pull requests are open to everyone, and we encourage newbies to start with good-first issues.

Setup Guide

To get started with contributing to Calcont Whiteboard, follow these simple steps:

  1. Clone the repository:

    git clone https://github.com/calcont/whiteboard.git

  2. Navigate to whiteboard directory

    cd whiteboard

  3. Install dependencies

    npm install

  4. Start the project

    npm run start

That's it! You're now ready to start contributing.🚀

Pull Request Guidelines

When submitting a pull request, make sure your title starts with following prefix

  • Feature: A new feature.
  • Bug Fix: A bug fix.
  • Refactor: A code change that neither fixes a bug nor adds a feature.
  • Style: A scss/css or design changes.

Technologies Used

Calcont Whiteboard is primarily built on React.js. To simplify canvas implementation, we use Fabric.js. You can find the documentation for Fabric.js here . Additionally, we use Material-UI for UI components and lucide-react for icons. You can find their links below: