Hi there! 👋

A template created to be reused in some projects saving a lot of time and make our lives easier 🤍

What is inside?

• NextJS
• ReactJS
• TypeScript
• Tailwind
• Framer Motion
• Cypress
• Eslint
• Prettier
• Husky
• Commitlint

Getting Started

Install dependencies

pnpm install

or

yarn

or

npm install

Run development server

pnpm dev

or

yarn dev

or

npm run dev

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

Structure

└── cypress
    ├── e2e
└── src
    ├── app
    ├── assets
    ├── components
    ├── lib
    ├── utils

Folder	Description
e2e	e2e tests in the app
app	Pages
assets	Images and static files for application
components	Pages components
lib	Configuration of libraries used in the project
utils	Auxiliary and reusable functions

Conventions

Components

└── <MyComponent>
    ├── <MyComponent>.tsx
    ├── <MyComponent>.spec.tsx
    └── index.ts

Files	Description
.tsx	Component implementation
.spec.tsx	Component tests
index.ts	File to export the component

Commands

• dev: run development server
• build: creates the production build version
• lint: runs the linter in all components and pages
• cypress: open cypress
• format: format the files.
• component-test: run all the component tests.
• e2e-test: run all the e2e tests.
• commit: commit staged changes

Made with 🤍 by Arthur