- Install NodeJs.18 (LTS)
- Install Yarn:
npm -g install yarn
- Press
Clone
button. - Install and run project:
yarn
yarn start
- Because files are not executable by default; they must be set to be executable.
chmod ug+x .husky/*
chmod ug+x .git/hooks/*
yarn commit
yarn release:patch // Patch release 0.1.0 -> 0.1.1
yarn release:minor // Minor release 0.1.1 -> 0.2.0
yarn release:major // Major release 0.2.0 -> 1.0.0
Name | Description |
---|---|
src/ | Source files |
src/assets/ | |
src/context/ | |
src/data/ | |
src/entities/ | |
src/helpers/ | |
src/hooks/ | |
src/layouts/ | |
src/libs/ | |
src/modules/ | |
src/pages/ | |
src/routes/ | |
src/services/ | |
src/store/ | |
src/ui/ | |
src/utility-types/ | |
src/utils/ | |
src/widgets/ | |
tests/ | Test cases will be placed here |
tests/unit/ | Unit Test cases will be placed here |
tests/e2e/ | E2E testing |
tests/integration/ | API routes (Integration) Test cases will be placed here |
- This PR implements new feature, fix bug, or some other changes
- If PR is not ready to review mark it as Draft
- All commits in this PR should be created by
yarn commit
by conventional-commits - Title of the PR should have issue(s) identifier(s) ("BOX-123 Example title of PR")