Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thejessemartins/sistema-anotacoes-api
Esta é uma API RESTful desenvolvida em Go com Gin e GORM para gerenciar um sistema de anotações pessoais. Com esta API, é possível criar e gerenciar usuários, anotações e categorias de notas, facilitando a organização de informações pessoais.
https://github.com/thejessemartins/sistema-anotacoes-api
gin golang gorm sqlite
Last synced: 29 days ago
JSON representation
Esta é uma API RESTful desenvolvida em Go com Gin e GORM para gerenciar um sistema de anotações pessoais. Com esta API, é possível criar e gerenciar usuários, anotações e categorias de notas, facilitando a organização de informações pessoais.
- Host: GitHub
- URL: https://github.com/thejessemartins/sistema-anotacoes-api
- Owner: thejessemartins
- License: mit
- Created: 2024-10-25T11:53:41.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-25T11:57:01.000Z (3 months ago)
- Last Synced: 2024-11-04T09:41:15.280Z (2 months ago)
- Topics: gin, golang, gorm, sqlite
- Language: Go
- Homepage:
- Size: 9.52 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sistema de Anotações Pessoais API
Esta é uma API RESTful desenvolvida em Go com [Gin](https://github.com/gin-gonic/gin) e [GORM](https://gorm.io/) para gerenciar um sistema de anotações pessoais. Com esta API, é possível criar e gerenciar usuários, anotações e categorias de notas, facilitando a organização de informações pessoais.
## Funcionalidades
- **Gerenciamento de Usuários**: Cadastro, listagem de usuários e autenticação.
- **Gerenciamento de Notas**: Criação, listagem, edição e exclusão de anotações.
- **Organização por Categorias**: Cada nota pode pertencer a uma ou mais categorias.
## Tecnologias Utilizadas
- **Go**: Linguagem principal de desenvolvimento.
- **Gin**: Framework web para Go.
- **GORM**: ORM para Go.
- **SQLite**: Banco de dados relacional leve e de fácil configuração.
## Estrutura do Projeto
```plaintext
sistema-anotacoes-api/
├── database/ # Conexão com o banco de dados SQLite
├── models/ # Definições de modelos (usuário, nota, categoria, categoria_nota)
├── controllers/ # Lógica de negócio para cada entidade
├── routes/ # Definição das rotas para cada entidade
├── main.go # Arquivo principal para inicialização da API
└── go.mod # Configuração de módulos do Go
```
## Pré-requisitos
Certifique-se de ter o [Go](https://golang.org/doc/install) instalado na versão 1.16 ou superior.
## Como Executar
1. Clone o repositório:
```bash
git clone https://github.com/thejessemartins/sistema-anotacoes-api.git
cd sistema-anotacoes-api
```
2. Instale as dependências:
```bash
go mod tidy
```
3. Execute a aplicação:
```bash
go run main.go
```
A API estará disponível em `http://localhost:8080`.
## Contribuindo
Se você deseja contribuir com este projeto:
1. Faça um fork do projeto.
2. Crie uma nova branch com sua feature (`git checkout -b minha-feature`).
3. Commit suas alterações (`git commit -m 'feat: Minha nova feature'`).
4. Envie para a branch principal (`git push origin minha-feature`).
5. Abra um Pull Request.
## Licença
Este projeto está licenciado sob a Licença MIT - consulte o arquivo [LICENSE](LICENSE) para mais detalhes.
---
## Contato
Para mais informações, entre em contato através do e-mail: `[email protected]`.