Skip to content

README.md

Latest commit

 

History

History
47 lines (35 loc) · 1.62 KB

README.md

File metadata and controls

47 lines (35 loc) · 1.62 KB

GoShort

GoShort is URL shortener service built with Go. This project demonstrates my expertise in backend development, API design, frontend.

Features

  • 🚀 Fast & Efficient: Built with Fiber for low-latency HTTP handling.
  • 🗄️ PostgreSQL: Robust data storage.
  • 🔒 Security: JWT authentication, Basic Auth for sensitive endpoints, and environment-based configuration.
  • 🧪 Testing: Comprehensive unit tests.
  • 📚 API Documentation: Swagger UI with protected access.
  • 🛠️ Clean Architecture: Modular codebase for maintainability and scalability.
  • 🖥️ Frontend: React-based UI for easy link management (if applicable).

Tech Stack

  • Go (Fiber, SQLC)
  • PostgreSQL (primary database)
  • React (frontend)
  • Docker (containerization)
  • Swagger (API docs)

Getting Started

  1. Clone the repository
  2. Use Go 1.24
    • Make sure you have Go 1.24 installed.
  3. Configure environment variables
    • Copy .env.example to .env and fill in your credentials.
  4. Run with Docker Compose
  5. Access the service
    • API: http://localhost:8080
    • Swagger: http://localhost:8080/swagger/index.html

Key Skills Demonstrated

  • Go Backend Engineering: Fiber, middleware, JWT, Basic Auth, RESTful APIs.
  • Database Design: Efficient schema, migrations.
  • Security Best Practices: Auth, environment configs, protected endpoints.
  • Frontend Integration: React SPA (if included).

License

This project is open-source and available under the MIT License.

Author: agpprastyo