Welcome to the project! This guide will walk you through setting up the development environment and the processes required for contributing effectively.
-
Node.js and npm
Ensure you have [Node.js] installed. -
Linting and Formatting Install these extensions (VS Code)
- ESLint
- Prettier
-
Clone the Repository Copy code
git clone <repository-url> cd <repository-name> -
Install Dependencies Run the following command to install all required dependencies:
npm install -
Set up Husky for precommit hooks
- Formatting and Linting
-
To format the code:
npm run format -
To check linting errors:
npm run lint
-
Testing
npm test -
Pre-commit Hooks:
Husky ensures that linting and formatting rules are enforced before commits. If changes fail these checks, they will need to be fixed before committing.