Skip to content

playerony/fabric-efa

Repository files navigation

🙈 fabric-efa 🙈

Simple editor written with react and fabricjs for education purposes.

📖 Table of Contents

🌐 Links

🎨 Architecture

This is a mix of:

  • atomic design pattern,
  • clean architecture pattern,

Here is an explanation of how each layer depends on each other: image

✨ Getting started

Prerequisites

You need to have installed the following software:

Bootstrap

  git clone [email protected]:playerony/fabric-efa.git
  cd fabric-efa
  npm install

📜 Scripts:

Development

  • storybook - Run storybook.
  • start - Run application in development mode.
  • reinstall-deps - Run will remove all dependencies and reinstall them.

Build

  • build - Build for production a ready application.
  • build-storybook - Build for production a ready storybook.

Test

  • test - Run tests.
  • test:ci - Run tests in CI mode.
  • test:watch - Run tests in watch mode.
  • test:coverage - Run tests in coverage mode.
  • test:update-snapshot: Run tests and update all snapshots.

Analyze

  • lint - Run eslint. Output any errors 🚨.
  • lint:fix - Run eslint with --fixflag . Fix any lint errors 🚨.
  • typecheck - Run tsc. Output any errors 🚨.
  • format - Run prettier to format all the files.
  • check - Run lint, typecheck and test. Output any errors 🚨.

📚 Documentation

Commit Message Guideline

  • For easier commit type recognition commit messages are prefixed with an emoji
  • See available gitmoji.dev