Esse é um boilerplate que será usado para o desenvolvimento dos meus próximos projetos pessoais. Nele, imprementei as principais tecnologias e ferramentas que aprendi durante o tempo de estudo, criando um ambiente inicial de desenvolvimento padronizado, organizado e de fácil uso, podendo assim, iniciar rapidamente qualquer novo projeto, que use essas tecnologias, sem a necessidade de configura-las.
Esse setup inicial conta com as seguintes tecnologias:
- NextJS 13
- TypeScript
- TailwindCSS
- Jest
- React Testing Library
- Storybook
- Plop
- Husky
- Lint Staged
- Commitlint
- Eslint
- Prettier
- Github Actions
Antes de baixar o projeto você vai precisar ter instalado na sua máquina as seguintes ferramentas:
# Gerando um repositório a partir desse template
Clique no botão verde: "Use this template"
Clique em "Create a new repository"
# Clone o repositório gerado
$ git clone git@github.com:yourUsername/yourRepository.git
# Acesse a pasta do projeto no terminal/cmd
$ cd yourRepository
# Abra essa pasta em seu editor de texto favorito
$ code .
# Instale as dependências
$ npm install
or
$ yarn
# Execute a aplicação web em modo de desenvolvimento
$ npm run dev
or
$ yarn dev
# O aplicativo inciará na porta:3000 - acesse http://localhost:3000
# Execute o storybook em modo de desenvolvimento
$ npm run storybook or yarn storybook
# O Storybook inciará na porta:6006 - acesse http://localhost:6006dev: Roda a aplicação emlocalhost:3000build: Cria a versão de produçãostorybook: Roda o Storybook emlocalhost:6006test: Roda os testes de todos os componentes e páginastest --watch: Roda os testes e continua assistindo modificações nos arquivoslint: Executa o linter em todos os componentes e páginasgenerate: Gera a estrutura de um novo componente
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ♥ by José Ronaldo 👋