samuelrms / Boilerplate

Boilerpalte Next.js + TailwindCSS + Typescript

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

2. Navigate to the project root folder

cd boilerplate

3. Install dependencies

yarn
# or
npm install

4. Run the development server

yarn dev
# or
npm run dev

5. Open http://localhost:3000 with your browser to see the result.

6. Run the command to run the application tests

yarn test
# or
npm run test

7. Run the command to run the application tests watch

yarn test:watch
# or
npm run test:watch

8. Enter the command to perform the code indentation checks

yarn style:check
# or
npm run style:check

9. Enter the command to perform the code indentation fixes

yarn style:fix
# or
npm run style:fix

10. Run husky install command to install git hooks

yarn prepare
# or
npm run prepare

11. Create commit with the command

git add <paths or '.' (for all)>

yarn commit

---

Stack and Tools

• Next.js
• TailwindCSS
• Typescript
• Jest
• React Testing Library
• Styled Components
• Husky
• Commitizen
• Commitlint
• Redux
• React Icons