Development Guide

Linting

We use eslint along with airbnb js style guide and prettier to help you write succident and beautiful code!

Typescript

In modern World of javascript, Typescript becomes a must, since it allows you to build typesafe js applications with less efforts, making them more reliable!

Unit Test

With jest and React Testing Library, you are allowed to build unit-tests in a smooth way!

Lint Staged

Lint Staged is a tool that allows us to only play with the changes added to "staging" status in git, this is helpful when you only want to test to style-check the chagnes that have been pushed in staging.

Hustky

Worrying about commiting shit code by accident ? Husky is right here for you, with it you can easily create git hooks, e.g: Building a "pre-commit" hook.

Commands

Installation

yarn

Development

yarn dev

Building Assets

Run this command to build bundles.

yarn build

Hosting Dynamic Content (Server-Side Rendering)

yarn start

Building Tests

yarn test:watch

Sytle Checks

yarn lint

Pre Commit Hook

Please make .husky/pre-commit executable

chmod +x .husky/pre-commit

Storybook

Please run these two commands in separate tabs

yarn tailwind:watch

yarn storybook

E2E Tests

Not yet decided which tool to go with Cypress of Playwright?.