An open API service indexing awesome lists of open source software.

https://github.com/aureliodeboa/alpha-construtora


https://github.com/aureliodeboa/alpha-construtora

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Alpha Construtora MVP

## Descrição

Este projeto é um sistema de gestão abrangente para empresas de construção civil. Ele oferece funcionalidades para controle de EPIs (Equipamentos de Proteção Individual), gestão de documentos, e um painel administrativo para gerenciamento de projetos e equipes.

---

## Funcionalidades

- **Login Seguro**: Sistema de autenticação para acesso às funcionalidades.
- **Controle de EPIs**: Gerenciamento de estoque e distribuição de equipamentos de proteção.
- **Gestão de Documentos**: Upload e organização de documentos importantes dos colaboradores.
- **Painel Administrativo**: Visão geral dos projetos e equipes.
- **Design Responsivo**: Interface adaptável para desktop e dispositivos móveis.

---

## Tecnologias Utilizadas

- **React**
- **TypeScript**
- **Tailwind CSS**
- **Shadcn UI**
- **Framer Motion** (para animações)
- **Lucide React** (para ícones)

---

## Pré-requisitos

Antes de iniciar, certifique-se de ter instalado em sua máquina:

- **Node.js** (versão 14 ou superior)
- **npm** ou **yarn**

---

## Instalação

### 1. Clone o repositório:

```bash
git clone https://github.com/aureliodeboa/alpha-construtora.git
cd alpha-construtora
```

### 2. Instale as dependências do projeto:

Utilizando **npm**:

```bash
npm install
```

Ou utilizando **yarn**:

```bash
yarn install
```

---

## Execução

### 1. Inicie o servidor de desenvolvimento:

Com **npm**:

```bash
npm run dev
```

Ou com **yarn**:

```bash
yarn dev
```

### 2. Acesse a aplicação no navegador:

Abra o navegador e acesse [http://localhost:3000](http://localhost:3000).

---

## Scripts Disponíveis

- **`npm run dev`** ou **`yarn dev`**: Inicia o servidor de desenvolvimento.
- **`npm run build`** ou **`yarn build`**: Cria uma versão de produção do projeto.
- **`npm run start`** ou **`yarn start`**: Inicia o servidor de produção.
- **`npm run lint`** ou **`yarn lint`**: Verifica e corrige problemas de linting no código.

---

## Estrutura de Diretórios

```
alpha-construtora/
├── public/ # Arquivos públicos (imagens, ícones, etc.)
├── src/ # Código-fonte do projeto
│ ├── components/ # Componentes reutilizáveis
│ ├── pages/ # Páginas da aplicação
│ ├── assets/ # Recursos estáticos (imagens, fontes)
│ └── App.tsx # Componente principal da aplicação
├── .env # Variáveis de ambiente
├── package.json # Configurações do projeto e dependências
└── README.md # Documentação do projeto
```

## Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo `LICENSE` para mais detalhes.

---