Sankhya-React

Imagem
Imagem da tecnologia TypeScript
Imagem da tecnologia React
Imagem da tecnologia Tailwind CSS
Imagem da tecnologia JavaScript

🚀 Projeto Base React para Sankhya-Om

Este é um projeto base React ⚛️ configurado para integração com o ERP Sankhya-Om. Ele inclui uma estrutura organizada, configurações para Webpack, Babel, Tailwind CSS, além de scripts para facilitar a clonagem e atualização de projetos. ✨


📌 Pré-requisitos

Antes de começar, certifique-se de ter instalado:

  • âś… Node.js (14.x ou superior)
  • âś… npm (geralmente vem com o Node.js)
  • âś… Git

Verifique as instalações com:

node --version
npm --version
git --version

🔧 Clonando o Projeto Base

Para criar um novo projeto baseado neste template:

# Acesse o diretĂłrio do projeto base
cd caminho/para/projeto-base-react-sankhya

# Execute o script de clonagem
./clone-project.sh nome-do-seu-novo-projeto

# Acesse o novo projeto
cd ../nome-do-seu-novo-projeto

đź“‚ Estrutura do Projeto

nome-do-seu-novo-projeto/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── common/
│   ├── pages/
│   ├── routes/
│   ├── contexts/
│   ├── services/
│   ├── controllers/
│   ├── hooks/
│   ├── utils/
│   ├── styles/
│   ├── assets/
│   ├── config/
│   ├── App.js
│   └── index.js
├── .babelrc
├── .biomeignore
├── .gitignore
├── jsconfig.json
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── webpack.config.js

🚀 Desenvolvimento

Instale as dependĂŞncias (caso o script de clonagem nĂŁo tenha feito isso automaticamente):

npm install

Inicie o ambiente de desenvolvimento:

npm start

📦 Build para Produção

Para gerar a build de produção:

npm run build

Isso criará um arquivo src.zip na raiz do projeto, pronto para ser enviado ao ERP Sankhya-Om.


🔄 Atualizando o Projeto Base

Se melhorias foram feitas no projeto base e deseja aplicá-las a projetos existentes:

# Acesse o diretĂłrio do projeto que deseja atualizar
cd caminho/para/seu-projeto

# Execute o script de atualização
./update-base-project.sh

📌 Nota: Revise as mudanças após a atualização para evitar conflitos ou ajustes manuais.


⚙️ Configurações Adicionais

📌 Aliases para Importação

O projeto suporta aliases para facilitar as importações:

import Button from '@components/Button';
import HomePage from '@pages/HomePage';

🎨 Tailwind CSS

O Tailwind CSS está configurado e pronto para uso! Basta adicionar as classes nos seus componentes.


🛠️ Biome.js para Formatação e Linting

Este projeto utiliza Biome.js 🌿 como ferramenta de formatação e linting, substituindo ESLint e Prettier.

đź“‹ Comandos Ăşteis

  • Formatar cĂłdigo:

    npx biome format .
    
  • Linting:

    npx biome lint .
    
  • Verificação geral:

    npx biome check .
    
  • Correção automática:

    npx biome check --apply .
    

🔌 Integração com VSCode

Para uma experiĂŞncia melhor, instale a extensĂŁo Biome.js no VSCode:

đź”— ExtensĂŁo Biome.js

⚡ Além disso, configure corretamente seu VSCode seguindo a documentação oficial.


🚨 Problemas Comuns

❌ Autoimport não funciona no VSCode

  1. Verifique se as extensões Biome.js e React estão instaladas.
  2. Reinicie o servidor TypeScript:
    • Abra a paleta de comandos (Ctrl+Shift+P ou Cmd+Shift+P)
    • Digite e selecione "TypeScript: Restart TS server"

❌ Erro ao fazer build

  1. Certifique-se de que todas as dependĂŞncias estĂŁo instaladas corretamente.
  2. Verifique se há erros de sintaxe ou importações incorretas no código.
  3. Revise a configuração do webpack.config.js.

🤝 Contribuindo

Fique Ă  vontade para contribuir! đź’ˇ

  • Crie uma issue para relatar problemas ou sugerir melhorias.
  • Faça um pull request com suas contribuições.

📜 Licença

Este projeto está licenciado sob a Licença MIT.

đź“ś MIT License