Skip to content
BranchesTags

Repository files navigation

GitHub Notes Application

Một ứng dụng full-stack hoàn chỉnh để quản lý ghi chú với tích hợp GitHub Pull Request. Bao gồm backend API viết bằng Golang và frontend React application.

🚀 Quick Start

# Khởi động full-stack application
make up

# Dừng tất cả services  
make down

# Build lại toàn bộ
make build

# Rebuild hoàn toàn (down->build->up)
make rebuild

# Xem tất cả lệnh
make help

📋 Xem hướng dẫn chi tiết: QUICKSTART.md

Tính năng

Authentication

  • Đăng ký user với email và password
  • Đăng nhập và nhận JWT token
  • Mật khẩu được hash bằng bcrypt
  • Middleware bảo vệ các API cần đăng nhập

Quản lý GitHub Profile

  • Lưu trữ GitHub username và token của user
  • Sử dụng token để gọi GitHub API
  • Kiểm tra và yêu cầu cấu hình GitHub token khi cần

Quản lý Notes

  • Tạo, đọc, cập nhật, xóa ghi chú
  • Liên kết ghi chú với GitHub Pull Request
  • Tự động fetch thông tin PR từ GitHub API
  • Lưu cache thông tin PR để tránh gọi API nhiều lần
  • Tìm kiếm ghi chú theo tiêu đề, nội dung, PR number, PR state
  • Phân trang kết quả

Công nghệ sử dụng

Backend

  • Framework: Golang với Gin framework
  • Database: PostgreSQL
  • ORM: GORM
  • Authentication: JWT
  • Password Hashing: bcrypt

Frontend

  • Framework: React 18
  • Routing: React Router DOM
  • HTTP Client: Axios
  • UI Framework: Bootstrap 5
  • Icons: Font Awesome
  • Notifications: React Toastify

DevOps

  • Containerization: Docker & Docker Compose
  • Build Tool: Create React App

Cấu trúc dự án

├── cmd/
│   └── main.go                 # Entry point của ứng dụng
├── internal/
│   ├── config/
│   │   └── config.go          # Cấu hình ứng dụng
│   ├── database/
│   │   └── database.go        # Kết nối database
│   ├── handlers/
│   │   ├── auth.go           # Handlers cho authentication
│   │   ├── user.go           # Handlers cho user management
│   │   └── note.go           # Handlers cho note management
│   ├── middleware/
│   │   └── auth.go           # Authentication middleware
│   ├── models/
│   │   └── models.go         # Database models
│   ├── services/
│   │   └── github.go         # GitHub API integration
│   └── utils/
│       ├── auth.go           # Authentication utilities
│       └── response.go       # Response utilities
├── frontend/                   # React frontend application
│   ├── public/
│   ├── src/
│   │   ├── components/       # Reusable UI components
│   │   ├── contexts/         # React Context providers
│   │   ├── pages/           # Page components
│   │   ├── services/        # API service functions
│   │   └── styles/          # Global styles
│   ├── package.json
│   └── README.md
├── migrations/
├── docker-compose.yml
├── Dockerfile
├── go.mod
└── README.md
│   ├── models/
│   │   └── models.go         # Database models và DTOs
│   ├── services/
│   │   └── github.go         # GitHub API service
│   └── utils/
│       ├── auth.go           # Authentication utilities
│       └── response.go       # Response utilities
├── migrations/               # Database migrations (nếu cần)
├── .env                     # Environment variables
├── docker-compose.yml       # Docker compose configuration
├── Dockerfile              # Docker configuration
├── go.mod                  # Go module dependencies
├── go.sum                  # Go module checksums
├── init.sql                # Database initialization
└── README.md               # Documentation

Cài đặt và chạy

Yêu cầu hệ thống

  • Docker và Docker Compose
  • Node.js 16+ và npm (cho frontend)
  • Go 1.23+ (nếu chạy backend local)
  • PostgreSQL (nếu chạy local)

Chạy Full Stack với Docker Compose (Khuyến nghị)

  1. Clone repository:
git clone <repository-url>
cd githubBE
  1. Tạo file .env cho backend (đã có sẵn, có thể chỉnh sửa nếu cần):
cp .env.example .env
  1. Chạy toàn bộ ứng dụng (backend + frontend + database):
docker-compose -f docker-compose.fullstack.yml up -d
  1. Kiểm tra trạng thái:
docker-compose -f docker-compose.fullstack.yml ps
  1. Ứng dụng sẽ chạy tại:

Chạy Development Mode (Frontend + Backend riêng biệt)

  1. Setup và chạy backend:
docker-compose up -d
  1. Setup frontend:
cd frontend
chmod +x setup.sh
./setup.sh
  1. Chạy frontend:
npm start
  1. Ứng dụng sẽ chạy tại:

Chạy chỉ Backend

  1. Chạy backend với Docker:
docker-compose up -d
  1. Kiểm tra logs:
docker-compose logs -f backend

Chạy Development Mode

Backend

  1. Cài đặt dependencies:
go mod tidy
  1. Chạy PostgreSQL:
docker run --name postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=github_notes -p 5432:5432 -d postgres:15-alpine
  1. Chạy backend:
go run cmd/main.go

Frontend

  1. Navigate to frontend directory:
cd frontend
  1. Cài đặt dependencies:
npm install
  1. Chạy development server:
npm start

Sử dụng ứng dụng

Frontend Interface

  1. Truy cập http://localhost:3000
  2. Đăng ký tài khoản mới hoặc đăng nhập
  3. Cập nhật GitHub profile (username và token) trong Profile settings
  4. Tạo, quản lý và tìm kiếm notes
  5. Liên kết notes với GitHub Pull Requests

GitHub Personal Access Token

Để sử dụng tính năng tích hợp GitHub PR:

  1. Vào GitHub Settings > Developer settings > Personal access tokens
  2. Tạo token mới với permissions:
    • public_repo - Truy cập repositories public
    • read:user - Đọc thông tin user profile
  3. Copy token và lưu vào Profile settings trong ứng dụng

API Documentation

Base URL

http://localhost:8080/api

Authentication

Đăng ký

POST /api/auth/register
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "password123"
}

Đăng nhập

POST /api/auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "password123"
}

User Management

Lấy thông tin profile

GET /api/user/profile
Authorization: Bearer <jwt_token>

Cập nhật GitHub profile

PUT /api/user/profile
Authorization: Bearer <jwt_token>
Content-Type: application/json

{
  "github_username": "yourusername",
  "github_token": "ghp_your_github_token"
}

Notes Management

Tạo ghi chú

POST /api/notes
Authorization: Bearer <jwt_token>
Content-Type: application/json

{
  "title": "My Note",
  "content": "Note content here",
  "github_pr_number": 123,
  "repo_owner": "owner",
  "repo_name": "repository"
}

Lấy danh sách ghi chú

GET /api/notes?page=1&limit=10&search=keyword&pr_number=123&pr_state=open
Authorization: Bearer <jwt_token>

Lấy chi tiết ghi chú

GET /api/notes/:id
Authorization: Bearer <jwt_token>

Cập nhật ghi chú

PUT /api/notes/:id
Authorization: Bearer <jwt_token>
Content-Type: application/json

{
  "title": "Updated Note",
  "content": "Updated content"
}

Xóa ghi chú

DELETE /api/notes/:id
Authorization: Bearer <jwt_token>

Ví dụ cURL

Đăng ký user mới

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

Đăng nhập

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

Cập nhật GitHub profile

curl -X PUT http://localhost:8080/api/user/profile \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{
    "github_username": "yourusername",
    "github_token": "ghp_your_github_token"
  }'

Tạo ghi chú với PR

curl -X POST http://localhost:8080/api/notes \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{
    "title": "Fix bug in authentication",
    "content": "This note describes the bug fix in PR #123",
    "github_pr_number": 123,
    "repo_owner": "facebook",
    "repo_name": "react"
  }'

Lấy danh sách ghi chú

curl -X GET "http://localhost:8080/api/notes?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Database Schema

Users Table

  • id (UUID, Primary Key)
  • email (String, Unique)
  • password_hash (String)
  • github_username (String, Optional)
  • github_token (String, Optional)
  • created_at (Timestamp)
  • updated_at (Timestamp)

Notes Table

  • id (UUID, Primary Key)
  • user_id (UUID, Foreign Key)
  • title (String, Max 255)
  • content (Text)
  • github_pr_number (Integer, Optional)
  • repo_owner (String, Optional)
  • repo_name (String, Optional)
  • created_at (Timestamp)
  • updated_at (Timestamp)

Pull Requests Table

  • id (UUID, Primary Key)
  • number (Integer)
  • repo_owner (String)
  • repo_name (String)
  • title (String)
  • body (Text)
  • author (String)
  • state (String)
  • url (String)
  • created_at (Timestamp)
  • updated_at (Timestamp)

Note PR Links Table (Many-to-Many)

  • note_id (UUID)
  • pr_id (UUID)

Environment Variables

# Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=github_notes
DB_SSL_MODE=disable

# JWT Configuration
JWT_SECRET=your_super_secret_jwt_key_here

# Server Configuration
PORT=8080

Bảo mật

  • Mật khẩu được hash bằng bcrypt
  • JWT token để authentication
  • Prepared statements với GORM để tránh SQL injection
  • GitHub token không được trả về trong API response
  • CORS middleware được cấu hình

Development

Thêm migration mới

# Nếu sử dụng migrate tool
migrate create -ext sql -dir migrations -seq migration_name

Chạy tests

go test ./...

Build production

docker build -t github-notes-backend .

Troubleshooting

Lỗi kết nối database

  • Kiểm tra PostgreSQL đã chạy
  • Kiểm tra thông tin kết nối trong .env
  • Kiểm tra network trong Docker Compose

Lỗi GitHub API

  • Kiểm tra GitHub token có quyền truy cập repository
  • Kiểm tra repository và PR number có tồn tại
  • Kiểm tra rate limit của GitHub API

Lỗi JWT

  • Kiểm tra JWT_SECRET trong .env
  • Kiểm tra token đã expired chưa
  • Kiểm tra format của Authorization header

Contributing

  1. Fork repository
  2. Tạo feature branch (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add some AmazingFeature')
  4. Push to branch (git push origin feature/AmazingFeature)
  5. Open Pull Request

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages