📝 NoteApp — REST API for Managing Notes

NoteApp is a production-ready Go (Golang) backend for managing personal notes with JWT authentication, PostgreSQL, clean architecture, and full DevOps setup.

Built with:

• Gin (HTTP framework)
• PostgreSQL (database)
• JWT + Refresh tokens (authentication)
• Clean Architecture (separation of layers)
• Structured logging (zap)
• Docker & Makefile (local dev)
• GitHub Actions CI/CD
• Migrations (golang-migrate)
• Unit & integration tests

---

🚀 Features

• ✅ User registration, login, logout, password change
• ✅ CRUD for notes with filtering (done/not done) and pagination
• ✅ JWT authentication with secure refresh token rotation
• ✅ Input validation with custom error messages
• ✅ Structured logging (JSON/console) with levels
• ✅ Graceful shutdown
• ✅ Automated testing with isolated test DB
• ✅ CI/CD pipeline (GitHub Actions)
• ✅ Docker-based local environment
• ✅ Configurable via YAML
• ✅ Migrations for schema versioning

---

🛠️ Tech Stack

Layer	Technology
Language	Go 1.24+
Framework	Gin
Database	PostgreSQL
Auth	JWT (HS256)
Logging	zap (Uber)
Validation	validator/v10
Password	bcrypt
Config	YAML
CI	GitHub Actions
Migrations	golang-migrate/migrate

---

📦 Prerequisites

• Go 1.24+
• PostgreSQL
• Docker (optional, for dev/test DB)
• migrate CLI
• make (for convenience)

---

⚙️ Configuration

Copy and edit the config:

cp configs/config.yaml

Edit configs/config.yaml with your DB and auth settings.

Example:

logger:
  level: info
  development: false
  disable_caller: false
  disable_stacktrace: false
  encoding: console
  output_paths: [stdout]
  error_output_paths: [stderr]

server:
  host: localhost
  port: 8080
  read_timeout: 60s
  write_timeout: 60s
  idle_timeout: 60s
  max_header_bytes: 1048576
  shutdown_timeout: 5s

db:
  cfg:
    max_open_conns: 10
    max_idle_conns: 5
    conn_max_life_time: 30m
    conn_max_idle_time: 10m

auth:
  access_token_ttl: 240h
  refresh_token_ttl: 720h

Make .env file Example

CONFIG_NAME=testing

CONTAINER_NAME=example

DB_DRIVER=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USER=example
DB_NAME=example
DB_PASSWORD=example
DB_SSL=disable

JWT_SECRET=example

---

🐳 Development Setup (Docker + Makefile)

Start the app with Dockerized PostgreSQL and auto-migrations:

make start

This will:

1. Start PostgreSQL in Docker
2. Create the database
3. Run migrations
4. Launch the server

Stop everything:

make stop

---

🧪 Testing

Run full test suite (with isolated test DB):

make test-start

This:

1. Starts a separate test DB in Docker
2. Creates test_notes_app
3. Runs migrations
4. Generates mocks
5. Runs go test
6. Cleans up

---

🌐 API Endpoints

Auth

METHOD	ENDPOINT	DESCRIPTION
POST	/api/auth/sign-up	Register
POST	/api/auth/sign-in	Login
GET	/api/auth/logout	Logout
GET	/api/auth/refresh	Refresh access token

Profile

Method	Endpoint	Description
GET	/api/profile	Get profile
PUT	/api/profile	Update profile
PUT	/api/profile/pass	Change password
DELETE	/api/profile	Delete account

Notes

Method	Endpoint	Description
POST	/api/notes	Create note
GET	/api/notes	List notes (pagination, "done")
GET	/api/notes/:note_id	Get note
PUT	/api/notes/:note_id	Update note
DELETE	/api/notes/:note_id	Delete note

---

🧰 Makefile Commands

Command	Description
make docker-up	# Starts all services defined in docker-compose.yaml in detached mode
make docker-down	Stops and removes all containers, networks, and volumes defined in docker-compose.yaml
make docker-logs	Streams logs from all services in real time (follow mode)
make docker-build	Builds or rebuilds the Docker images for all services defined in docker-compose.yaml
docker restart	Restarts the entire stack: stops containers, rebuilds images, then starts services
make test-start	Runs integration or end-to-end tests: starts Docker services, runs tests, then shuts down.
make run	Run the Go application directly (for local development)
make test	Run all Go tests with verbose output and coverage (DB must be up)
make mock	Generate mock implementations for interfaces using mockgen

---

🔄 CI/CD (GitHub Actions) The .github/workflows/default.yml runs on every push/pull_request to main/master:

✅ Checkout ✅ Setup Go ✅ Download deps ✅ Run tests ✅ Check formatting (gofmt)

---

🧪 Example Requests

Sign Up

curl -X POST http://localhost:8080/api/auth/sign-up \
  -H "Content-Type: application/json" \
  -d '{
    "username": "alice",
    "email": "alice@example.com",
    "password": "secure123"
  }'

Sign In

curl -X POST http://localhost:8080/api/auth/sign-in \
  -H "Content-Type: application/json" \
  -d '{
    "email": "alice@example.com",
    "password": "secure123"
  }'

---

📄 License

MIT License – see LICENSE for details.