Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amrmuhamedd/todo-app-go
A RESTful API for managing todos with user authentication built using Go and modern web technologies.
https://github.com/amrmuhamedd/todo-app-go
gin golang gorm jwt postgresql swagger
Last synced: 6 days ago
JSON representation
A RESTful API for managing todos with user authentication built using Go and modern web technologies.
- Host: GitHub
- URL: https://github.com/amrmuhamedd/todo-app-go
- Owner: amrmuhamedd
- Created: 2024-12-02T16:47:10.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2024-12-19T00:14:45.000Z (7 days ago)
- Last Synced: 2024-12-19T01:22:06.050Z (7 days ago)
- Topics: gin, golang, gorm, jwt, postgresql, swagger
- Language: Go
- Homepage: https://todo-app-go-9o2t.onrender.com/swagger/index.html
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Todo API
A RESTful API for managing todos with user authentication built using Go and modern web technologies.
## Technology Stack
- **Go** - Main programming language
- **Gin** - Web framework
- **GORM** - ORM for database operations
- **JWT** - Authentication mechanism
- **PostgreSQL** - Database
- **Swagger** - API documentation
- **bcrypt** - Password hashing
## Project Architecture
```
├── cmd/ # Application entry points
├── internal/ # Private application code
│ ├── auth/ # Authentication logic
│ ├── config/ # Configuration management
│ ├── database/ # Database connections and migrations
│ ├── handlers/ # HTTP request handlers
│ ├── middleware/ # HTTP middleware components
│ ├── models/ # Database models
│ └── routes/ # Route definitions
├── docs/ # Swagger documentation
└── main.go # Main application entry point
```
### Key Components
1. **Authentication**
- JWT-based authentication
- Secure password hashing with bcrypt
- Protected routes with middleware
2. **Database**
- GORM for database operations
- PostgreSQL for data persistence
- Models for Users and Todos
3. **API Endpoints**
- `/api/auth/signup` - User registration
- `/api/auth/login` - User authentication
- `/api/todos` - Todo CRUD operations
- Protected routes with JWT middleware
4. **Documentation**
- Swagger UI for API documentation
- Auto-generated API specs
## Getting Started
### Prerequisites
1. Go 1.19 or later
2. PostgreSQL
### Installation
1. Clone the repository
```bash
git clone
cd todo-api
```
2. Install dependencies
```bash
go mod download
```
3. Set up environment variables (create a .env file)
```env
JWT_SECRET=your_jwt_secret_key
DATABASE_URL=postgresql://username:password@localhost:5432/dbname?sslmode=disable
```
4. Run the application
```bash
go run main.go
```
The server will start at `http://localhost:8080`
### API Documentation
Access the Swagger documentation at:
```
http://localhost:8080/swagger/index.html
```
## Development
### Generate Swagger Documentation
```bash
swag init
```
### Run Tests
```bash
go test ./...
```
### Build for Production
```bash
go build -o todo-api
```
## Testing
### Running Tests
```bash
# Run all tests
go test ./...
# Run tests with coverage
go test -cover ./...
# Run tests for a specific package
go test ./internal/handlers
go test ./internal/auth
go test ./internal/middleware
```
### Test Structure
- `internal/test/test_helpers.go`: Common testing utilities and mock functions
- `internal/auth/jwt_test.go`: JWT token generation and validation tests
- `internal/handlers/auth_handler_test.go`: Authentication endpoint tests
- `internal/handlers/todo_handler_test.go`: Todo CRUD operation tests
- `internal/middleware/auth_middleware_test.go`: Authentication middleware tests
### Test Coverage
The test suite covers:
- JWT token generation and validation
- User authentication (signup/login)
- Todo CRUD operations
- Authentication middleware
- Error handling and edge cases
## API Endpoints
### Authentication
- `POST /api/auth/signup` - Register a new user
- `POST /api/auth/login` - Login and receive JWT token
### Todos
- `GET /api/todos` - List all todos
- `POST /api/todos` - Create a new todo
- `GET /api/todos/:id` - Get a specific todo
- `PUT /api/todos/:id` - Update a todo
- `DELETE /api/todos/:id` - Delete a todo
## Security
- All passwords are hashed using bcrypt
- JWT tokens are required for protected endpoints
- Environment variables for sensitive data
- Input validation on all endpoints