Basic commands and instructions to run the project:
- Clone this repository on your machine with the following command
git clone https://github.com/samuelrms/boilerplate.git
- Navigate to the project root folder
cd boilerplate
- Install dependencies
yarn
# or
npm install
- Run the development server
yarn dev
# or
npm run dev
-
Open http://localhost:3000 with your browser to see the result.
-
Run the command to run the application tests
yarn test
# or
npm run test
- Run the command to run the application tests watch
yarn test:watch
# or
npm run test:watch
- Enter the command to perform the code indentation checks
yarn style:check
# or
npm run style:check
- Enter the command to perform the code indentation fixes
yarn style:fix
# or
npm run style:fix
- Run husky install command to install git hooks
yarn prepare
# or
npm run prepare
- Create commit with the command
git add <paths or '.' (for all)>
yarn commit