Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/thejessemartins/sistema-de-ponto-eletronico-api

Este é um sistema de ponto eletrônico desenvolvido em Go usando o framework Gin e o ORM GORM com SQLite. A API permite gerenciar empresas, departamentos, funcionários e registros de ponto, fornecendo uma solução completa para a gestão de ponto eletrônico em uma empresa.
https://github.com/thejessemartins/sistema-de-ponto-eletronico-api

gin golang gorm sqlite

Last synced: 18 days ago
JSON representation

Host: GitHub
URL: https://github.com/thejessemartins/sistema-de-ponto-eletronico-api
Owner: thejessemartins
License: mit
Created: 2024-10-28T02:31:41.000Z (18 days ago)
Default Branch: master
Last Pushed: 2024-10-28T02:31:56.000Z (18 days ago)
Last Synced: 2024-10-28T08:10:20.011Z (18 days ago)
Topics: gin, golang, gorm, sqlite
Language: Go
Homepage:
Size: 17.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

## Descrição

## Características

- **Gestão de Empresas**: Criação, leitura, atualização e exclusão de empresas.
- **Gestão de Departamentos**: Criação, leitura, atualização e exclusão de departamentos.
- **Gestão de Funcionários**: Criação, leitura, atualização e exclusão de funcionários.
- **Gestão de Registros de Ponto**: Criação, leitura, atualização e exclusão de registros de ponto.
- **Automação de Migrações**: Migrações automáticas de banco de dados usando GORM.
- **Documentação de API**: Rotas bem definidas e documentadas para facilitar a integração.

## Tecnologias Utilizadas

- **Linguagem de Programação**: Go
- **Framework**: Gin
- **ORM**: GORM
- **Banco de Dados**: SQLite
- **Gerenciamento de Dependências**: Go Modules

## Estrutura do Projeto

```plaintext
ponto-eletronico/
├── database/
│ └── database.go
├── models/
│ ├── empresa.go
│ ├── departamento.go
│ ├── funcionario.go
│ └── registro_ponto.go
├── routes/
│ └── routes.go
├── controllers/
│ ├── empresa_controller.go
│ ├── departamento_controller.go
│ ├── funcionario_controller.go
│ └── registro_ponto_controller.go
├── main.go
├── go.mod
├── go.sum
├── README.md
└── LICENSE
```

## Pré-requisitos

- Go instalado (versão 1.16 ou superior)
- Git instalado

## Como Executar

1. **Clone o repositório**:

```sh
git clone https://github.com/thejessemartins/sistema-de-ponto-eletronico-api.git
cd sistema-de-ponto-eletronico-api
```

2. **Instale as dependências**:

```sh
go mod tidy
```

3. **Execute o projeto**:

```sh
go run main.go
```

O servidor será iniciado na porta 8080.

## Rotas da API

### Empresas

- `GET /api/empresas`: Listar todas as empresas.
- `POST /api/empresas`: Criar uma nova empresa.

### Departamentos

- `GET /api/departamentos`: Listar todos os departamentos.
- `POST /api/departamentos`: Criar um novo departamento.

### Funcionários

- `GET /api/funcionarios`: Listar todos os funcionários.
- `POST /api/funcionarios`: Criar um novo funcionário.

### Registros de Ponto

- `GET /api/registros-ponto`: Listar todos os registros de ponto.
- `POST /api/registros-ponto`: Criar um novo registro de ponto.

## Contribuindo

Contribuições são bem-vindas! Por favor, abra uma issue ou envie um pull request.

### Diretrizes de Contribuição

1. **Fork** o projeto.
2. Crie um **branch** para sua feature (`git checkout -b feature/NovaFeature`).
3. Faça o **commit** das suas mudanças (`git commit -m 'Adiciona NovaFeature'`).
4. Faça o **push** para o branch (`git push origin feature/NovaFeature`).
5. Abra um **Pull Request**.

## Detalhes de Contato

- **Mantenedor**: Jessé Martins (jessemartins.programaçã[email protected])

## Licença

Este projeto está licenciado sob a Licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.