A Twitter-like social media API built with Go that allows users to create accounts, authenticate, and post short messages called "chirps".
- 🔐 User Authentication - JWT-based authentication with refresh tokens
- 📝 Chirp Management - Create, read, and delete chirps (max 140 characters)
- 🔍 Content Filtering - Automatic profanity filtering
- 👑 Premium Features - Chirpy Red subscription via webhooks
- 📊 Admin Dashboard - Metrics and system management
- 🗄️ PostgreSQL Database - Robust data persistence with migrations
- 🚀 RESTful API - Clean HTTP API design
- Language: Go 1.24.4
- Database: PostgreSQL
- ORM: sqlc for type-safe SQL queries
- Authentication: JWT tokens with bcrypt password hashing
- Migrations: Goose for database schema management
- Environment: dotenv for configuration
- Go 1.24.4 or higher
- PostgreSQL database
- Environment variables configured
- Clone the repository:
git clone https://github.com/karprabha/chirpy.git
cd chirpy- Install dependencies:
go mod download- Set up environment variables:
# Create a .env file in the root directory
DB_URL=postgres://username:password@localhost:5432/chirpy_db?sslmode=disable
JWT_SECRET=your-secret-key-here
POLKA_KEY=your-polka-webhook-key
PLATFORM=dev- Run database migrations:
goose -dir sql/schema postgres "postgres://username:password@localhost/gator?sslmode=disable" up- Start the server:
go run cmd/server/main.goThe server will start on port 8080.
Comprehensive API documentation is available in the /docs folder:
- Authentication API - User login, registration, and token management
- Users API - User profile management
- Chirps API - Chirp creation, retrieval, and management
- Admin API - Administrative endpoints and metrics
- Webhooks API - External integrations and premium features
- Health Check API - Server health monitoring endpoint
chirpy/
├── cmd/server/ # Application entry point
├── internal/
│ ├── auth/ # Authentication utilities
│ ├── config/ # Configuration management
│ ├── database/ # Database models and queries
│ ├── handler/ # HTTP handlers
│ └── middleware/ # HTTP middleware
├── sql/
│ ├── queries/ # SQL queries for sqlc
│ └── schema/ # Database migrations
├── docs/ # API documentation
└── assets/ # Static assets
The application uses PostgreSQL with the following main tables:
- users - User accounts with authentication
- chirps - User posts/messages
- refresh_tokens - JWT refresh token management
Chirpy uses JWT tokens for authentication:
- Access tokens - Short-lived (1 hour) for API access
- Refresh tokens - Long-lived (60 days) for token renewal
- Password hashing - bcrypt for secure password storage
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
This project is licensed under the MIT License - see the LICENSE file for details.
When running locally: http://localhost:8080
Test if the server is running:
curl http://localhost:8080/api/healthzFor questions or issues, please open an issue on GitHub.