# realworld-gin-sqlc

**Repository Path**: itsforkgithub/realworld-gin-sqlc

## Basic Information

- **Project Name**: realworld-gin-sqlc
- **Description**: https://github.com/aliml92/realworld-gin-sqlc
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-27
- **Last Updated**: 2024-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ![RealWorld Example App](logo.jpg)

[![test](https://github.com/aliml92/realworld-gin-sqlc/actions/workflows/test.yaml/badge.svg?branch=master&event=push)](https://github.com/aliml92/realworld-gin-sqlc/actions/workflows/test.yaml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/aliml92/realworld-gin-sqlc/blob/master/LICENSE)
> ### Golang/Gin codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.


### [Demo](https://demo.realworld.io/)    [RealWorld](https://github.com/gothinkster/realworld)


This codebase was created to demonstrate a fully fledged fullstack application built with **Golang/Gin** including CRUD operations, authentication, routing, pagination, and more.


# How it works
![Diagram](diagram.png) 
* The project uses:
    * [gin-gonic/gin](https://github.com/gin-gonic/gin) as the web framework
    * [jackc/pgx](https://github.com/jackc/pgx) as the database driver
    * [kyleconroy/sqlc](https://github.com/kyleconroy/sqlc) to generate Go code from SQL queries
    * [golang-migrate/migrate](https://github.com/golang-migrate/migrate) to manage database migrations
    * [golang-jwt/jwt](https://github.com/golang-jwt/jwt) for authentication
    * [zap](https://github.com/uber-go/zap) for logging
    * [spf13/viper](https://github.com/spf13/viper) for configuration
    * [rs/xid](https://github.com/rs/xid) for generating UUIDs
    * [stretchr/testify](https://github.com/stretchr/testify) for testing
    * [golang/mock](https://github.com/golang/mock) for mocking dependencies
    * [ory/dockertest](https://github.com/ory/dockertest) for test database container during e2e test
    * [swaggo/swag](https://github.com/swaggo/swag) for API documentation
* Also uses:
    * *PostgreSQL* for the database
    * *Elasticsearch* for the search engine (optional, to be implemented)
    * *Typesense* for the search engine
# Getting started 
Running the project locally:

```
    docker-compose up -d // starts postgres container
    go run main.go
```

Project starts on port 8085 by default and swagger documentation is available at [http://localhost:8085/swagger/index.html](http://localhost:8085/swagger/index.html). 

# E2E testing
First, run:
```
   make test-run 
```
This will start postgres container and the project itself. Then, run the tests with:
```
    make e2e-test
```

# Unit testing
```
    make unit-test
```

# TODO
* [x] Add unit tests for handlers (... in progress)
* [ ] Improve error handling and logging
* [x] Improve deployment and testing configuration (Makefile, docker-compose, etc.) ( ... in progress)
* [x] Add search feature (`/search`, ...)