playerony / fabric-efa

Simple editor written with react and fabricjs for education purposes.

🙈 fabric-efa 🙈

Simple editor written with react and fabricjs for education purposes.

📖 Table of Contents

• 🌐 Links
• 🎨 Architecture
• ✨ Getting started
  • Prerequisites
  • Bootstrap
• 📜 Scripts
  • Development
  • Build
  • Test
  • Analyze
• 📚 Documentation
  • Commit Message Guideline

🌐 Links

• Storybook: https://yellow-beach-0ad556203.azurestaticapps.net
• Application: https://thankful-smoke-0ce524e03.azurestaticapps.net

🎨 Architecture

This is a mix of:

• atomic design pattern,
• clean architecture pattern,

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

✨ Getting started

Prerequisites

You need to have installed the following software:

• nodejs (>=14.15.0)
• npm (>= 6.14.0)

Bootstrap

  git clone [e-mail]: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