https://github.com/royroki/notetaker
NoteTaker - A simple Go-based backend demonstration for beginners, following Clean Architecture principles.ckend demonstration for beginners, following Clean Architecture principles.
https://github.com/royroki/notetaker
api backend beginner-project clean-architecture go-backend golang
Last synced: 5 months ago
JSON representation
NoteTaker - A simple Go-based backend demonstration for beginners, following Clean Architecture principles.ckend demonstration for beginners, following Clean Architecture principles.
- Host: GitHub
- URL: https://github.com/royroki/notetaker
- Owner: RoyRoki
- Created: 2025-03-05T13:34:07.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-04T20:20:46.000Z (about 1 year ago)
- Last Synced: 2025-06-12T13:07:22.556Z (about 1 year ago)
- Topics: api, backend, beginner-project, clean-architecture, go-backend, golang
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📝 NoteTaker
A simple and modular 🧱 **Go-based Note Taking API** built with:
- 💎 **Clean Architecture**
- 💡 **SOLID Principles**
- 🧪 **Testable structure**
- 🗃️ SQLite (can be easily swapped)
- ⚙️ Dependency Injection for better maintainability
- 🌐 Simple REST API
---
## 📽️ Demo
Check out a quick walkthrough of the project setup and code structure:
[](https://youtu.be/C6deIp21r5E?si=LDtkRswd7m7gnUbH)
---
## 📦 Project Structure
```bash
.
├── cmd # App entrypoint
│ └── server # Main server file
├── commons # Shared utilities (config, logging, DB, etc.)
├── modules
│ └── notes
│ ├── data # Data layer (models, datasource, impls)
│ ├── domain # Domain layer (interfaces, usecases)
│ ├── di # Dependency injection
│ └── presentation # HTTP controllers and routers
├── test.html # Quick test UI (excluded from stats)
├── notes.db # SQLite database file
└── README.md # You're here!
```
---
## 🧠 Key Concepts
### 🧼 Clean Architecture
- Separated concerns across data, domain, and presentation
- Easily testable and scalable
### 🧱 SOLID Principles
- Each layer has a single responsibility
- Interfaces are implemented explicitly
- High-level code is decoupled from low-level details
---
## 🚀 Getting Started
### 1. Clone the repo
```bash
git clone https://github.com/RoyRoki/NoteTaker.git && cd NoteTaker
```
### 2. Run the server
```bash
go run cmd/server/main.go
```
### 3. Access the API
```bash
GET /notes
POST /notes
PUT /notes/:id
DELETE /notes/:id
```
You can use `test.html` locally to quickly test endpoints.
---
## 🛠️ Tech Stack
- Go 🐹
- SQLite 🛢️
- chi router 🧭
- sqlx (optionally pluggable)
---
## 🤝 Contributions
PRs and stars are welcome! ⭐ If you're interested in Clean Architecture or Go backend design, this project is a great starting point!
---
## 📄 License
ROCKET © [RoyRoki](https://github.com/RoyRoki)