Skip to content

README.md

Latest commit

 

History

History
106 lines (74 loc) · 2.93 KB

README.md

File metadata and controls

106 lines (74 loc) · 2.93 KB

logotipo Access Pilot

Access Pilot - Frontend

react typescript vite yarn

“Smaller in number are we, but larger in mind.” — Yoda

Olá! Este é o frontend do Access Pilot. Um produto getInsight.

🚀 Tecnologias

Este projeto utiliza as seguintes tecnologias:

  • React 18.3.1
  • TypeScript 5.5.3
  • Vite 5.4.1
  • Radix UI
  • Tailwind CSS

📋 Pré-requisitos

Para continuar, atente aos pré-requisitos:

  • Node.js 18+ ou 20+
    • Como instalar?
      • Via NVM: nvm install 20 (recomendado)
      • Instalação manual: baixar
  • Yarn 1.22.22
    • Como instalar?
      • Via npm: npm install -g yarn@1.22.22 (recomendado)
      • Instalação manual: baixar

🔧 Instalação e Configuração

1. Clone o repositório

git clone https://github.com/getInsight-it/accesspilot-frontend.git
cd accesspilot-frontend

2. Instale as dependências

yarn install

3. Configure as variáveis de ambiente

Edite o arquivo public/assets/env/env.js com as configurações do seu ambiente:

window.env = {
  API_URL: 'https://api.accesspilot.dev.getinsight.tech',
  FRONTEND_URL: 'http://localhost:5173',
  KEYCLOAK_URL: 'https://keycloak.cloud.getinsight.tech',
  KEYCLOAK_REALM: 'access-pilot',
  KEYCLOAK_CLIENT_ID: 'accesspilot-frontend',
  KEYCLOAK_REFRESH_TOKEN_TIME: 30,
  DASHBOARD_REFRESH_INTERVAL: 5000000000
}

4. Execute o projeto

# Modo desenvolvimento
yarn dev

# Build para produção
yarn build

# Preview da build de produção
yarn preview

O projeto estará disponível em http://localhost:5173

🧪 Linting

# Executar ESLint
yarn lint

🤝 Como contribuir?

Para contribuir com o projeto, começe lendo as orientações do CONTRIBUTING.md. Além disso, esperamos que todos os participantes da comunidade cumpram nosso Código de Conduta. Por favor, leia-o e siga-o.

Licença

O Access Pilot e todos os seus derivados estão licenciados sob os termos da licença Apache v2.0.