https://github.com/playerony/fabric-efa

Simple editor written with react and fabricjs for education purposes.
https://github.com/playerony/fabric-efa

app architecture atomic atomic-design clean clean-architecture design efa fabric fabric-efa fabricjs javascipt javascript pattern react storybook typesc typescript

Last synced: 3 days ago
JSON representation

Simple editor written with react and fabricjs for education purposes.

• Host: GitHub
• URL: https://github.com/playerony/fabric-efa
• Owner: playerony
• License: mit
• Created: 2021-06-20T11:57:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-04T14:15:26.000Z (over 3 years ago)
• Last Synced: 2023-03-08T05:38:17.068Z (almost 2 years ago)
• Topics: app, architecture, atomic, atomic-design, clean, clean-architecture, design, efa, fabric, fabric-efa, fabricjs, javascipt, javascript, pattern, react, storybook, typesc, typescript
• Language: TypeScript
• Homepage: https://thankful-smoke-0ce524e03.azurestaticapps.net/
• Size: 4.86 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🙈 fabric-efa 🙈

Simple editor written with react and fabricjs for education purposes.

## 📖 Table of Contents

- [🌐 Links](#user-content--links)

- [🎨 Architecture](#user-content--architecture)

- [✨ Getting started](#user-content--getting-started)

  - [Prerequisites](#prerequisites)

  - [Bootstrap](#bootstrap)

- [📜 Scripts](#user-content--scripts)

  - [Development](#development)

  - [Build](#build)

  - [Test](#test)

  - [Analyze](#analyze)

- [📚 Documentation](#user-content--documentation)

  - [Commit Message Guideline](#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:

![image](https://michalzalecki.com/posts/[email protected])

## ✨ Getting started

### Prerequisites

You need to have installed the following software:

- [nodejs](https://nodejs.org/en/) (>=14.15.0)

- [npm](https://npmjs.com/) (>= 6.14.0)

### Bootstrap

```bash

  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 `--fix`flag . 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](https://gitmoji.dev/)