Skip to content

samuelrms/Boilerplate

Repository files navigation

Boilerpalte Next.js + TailwindCSS + Typescript

Getting Started

Basic commands and instructions to run the project:

  1. Clone this repository on your machine with the following command
git clone https://github.com/samuelrms/boilerplate.git
  1. Navigate to the project root folder
cd boilerplate
  1. Install dependencies
yarn
# or
npm install
  1. Run the development server
yarn dev
# or
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

  2. Run the command to run the application tests

yarn test
# or
npm run test
  1. Run the command to run the application tests watch
yarn test:watch
# or
npm run test:watch
  1. Enter the command to perform the code indentation checks
yarn style:check
# or
npm run style:check
  1. Enter the command to perform the code indentation fixes
yarn style:fix
# or
npm run style:fix
  1. Run husky install command to install git hooks
yarn prepare
# or
npm run prepare
  1. Create commit with the command
git add <paths or '.' (for all)>

yarn commit

Stack and Tools

image