cra-template-boilerplate-iks v0.1.3

Create React App README Original disponivel aqui

💻 Motivação

A ideia foi criar um template foi com o intuito de agilizar o processo de criação de um projeto React. Já instalando as dependências, o projeto já está pronto para ser utilizado. E também com dark theme e estilo de cores padrão para facilitar no inicio do desenvolvimento.

Como Usar

npx create-react-app nome-do-projeto --template boilerplate-iks

Ou

yarn create react-app nome-do-projeto --template boilerplate-iks

npx comando instala a versão estável mais recente do CRA do npm.

--template parâmetro aponta para este modelo, note que o prefixo cra-template- é omitido.

Devido às limitações do modelo CRA (podemos alterar apenas scripts e dependências dentro do package.json gerado) toda a configuração é feita adicionando arquivos de configuração sempre que possível. Por não ter a opção devDependencies você precisará instalar mais algumas bibliotecas executando este comando:

yarn add -D @commitlint/cli @commitlint/config-conventional @types/react-router-dom @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import-helpers eslint-plugin-prettier eslint-plugin-react husky lint-staged prettier prettier-eslint prettier-eslint-cli @types/jest @types/node @types/react @types/react-dom

Ou

npm i -D @commitlint/cli @commitlint/config-conventional @types/react-router-dom @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import-helpers eslint-plugin-prettier eslint-plugin-react husky lint-staged prettier prettier-eslint prettier-eslint-cli @types/jest @types/node @types/react @types/react-dom

Scripts Disponíveis

No diretório do projeto, você pode executar:

• yarn dev- executa o aplicativo no modo de desenvolvimento

• yarn start - executa o aplicativo no modo de build. Abra http://localhost:3000 para visualizá-lo no navegador.

• yarn test - inicia o executor de teste no modo de observação interativo.

• yarn build - constrói o aplicativo para produção na pasta build.

• yarn eject - expõe o conteúdo do pacote react-script.

• yarn lint - corrige arquivos de projeto de acordo com as regras eslint.

• yarn prepare - prepara o hook de commit do husky.

🧪 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Axios
• Eslint
• React
• React Hot Toast
• React Icons
• React Router Dom
• Sass
• TypeScript

⚙ Como rodar este projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Git

Node.js

E também será preciso um editor, eu indico o VSCode

Rodando o projeto 🚧

# Clone este repositório
$ git clone https://github.com/ialexanderbrito/cra-template-boilerplate-iks

# Acesse a pasta do projeto no terminal/cmd
$ cd './cra-template-boilerplate-iks'

# Instale as dependências
$ npm install ou yarn

♻️ Como contribuir

• Fork esse repositório;
• Crie uma branch com a sua feature: git checkout -b my-feature
• Commit suas mudanças: git commit -m 'feat: My new feature'
• Push a sua branch: git push origin my-feature

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.