KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

golang-grpc-realworld-example

★ 133 Open GitHub ↗

A real world backend API built with golang + grpc

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![realworld-logo](https://user-images.githubusercontent.com/13511520/81056310-4bf24b00-8f05-11ea-91d5-c98e1d6d621e.png)
---

[![Test Status](https://github.com/raahii/golang-grpc-realworld-example/workflows/test/badge.svg)](https://github.com/raahii/golang-grpc-realworld-example/actions?query=workflow%3Atest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/raahii/golang-grpc-realworld-example/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/raahii/golang-grpc-realworld-example?status.svg)](https://godoc.org/github.com/raahii/golang-grpc-realworld-example)

> ### Go/GRPC codebase containing RealWorld examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.

### [Demo](https://github.com/gothinkster/realworld)&nbsp;&nbsp;&nbsp;&nbsp;[RealWorld](https://github.com/gothinkster/realworld)

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

## How it works

![figure](https://user-images.githubusercontent.com/13511520/81476790-bd583380-924e-11ea-99ba-63c973f121e5.png)

- Using [grpc-gateway](https://grpc-ecosystem.github.io/grpc-gateway/) as reverse-proxy server which translates a **RESTful JSON API into gRPC**.

- Using **Go** to implement realworld backend server.

- grpc: [grpc-go](https://github.com/grpc/grpc-go)
  - auth token: [jwt-go](https://github.com/dgrijalva/jwt-go)
  - ORM: [gorm](https://github.com/jinzhu/gorm)
  - logging: [zerolog](https://github.com/rs/zerolog)

- Using **MySQL** to store data.

## Getting started

The app listens and serves on `0.0.0.0:3000`.

- docker-compose

```
  $ docker-compose up -d
  ```

- local

- Install Go 1.19+, MySQL
  - set environment variables to connect database [like this](https://github.com/raahii/golang-grpc-realworld-example/blob/master/env/local.env).

```
  $ go run server.go # run grpc server
  $ go run gateway/gateway.go # run grpc-gateway server
  ```

## Unit test
  - docker-compose

```
    $ docker-compose run app make unittest
    ```

- local

```
    $ make unittest
    ```

## E2E test

$ make e2etest

## TODOs

- [x] Users and Authentication
  - [x] `POST /user/login`: Existing user login
  - [x] `POST /users`: Register a new user
  - [x] `GET /user`: Get current user
  - [x] `PUT /user`: Update current user
- [x] Profiles
  - [x] `GET /profiles/{username}`: Get a profile
  - [x] `POST /profiles/{username}/follow`: Follow a user
  - [x] `DELETE /profiles/{username}/follow`: Unfollow a user
- [x] Articles
  - [x] `GET /articles/feed`: Get recent articles from users you follow
  - [x] `GET /articles`: Get recent articles globally
  - [x] `POST /articles `: Create an article
  - [x] `GET /articles/{slug}`: Get an article
  - [x] `PUT /articles/{slug}`: Update an article
  - [x] `DELETE /articles/{slug}`: Delete an article
- [x] Comments
  - [x] `GET /articles/{slug}/comments`: Get comments for an article
  - [x] `POST /articles/{slug}/comments`: Create a comment for an article
  - [x] `DELETE /articles/{slug}/comments/{id}`: Delete a comment for an article
- [x] Favorites
  - [x] `POST /articles/{slug}/favorite`: Favorite an article
  - [x] `DELETE /articles/{slug}/favorite`: Unfavorite an article
- [x] Deafult
  
- [x] `GET /tags`: Get tags
  
- [x] E2E test
  ```
  ┌─────────────────────────┬───────────────────┬───────────────────┐
  │                         │          executed │            failed │
  ├─────────────────────────┼───────────────────┼───────────────────┤
  │              iterations │                 1 │                 0 │
  ├─────────────────────────┼───────────────────┼───────────────────┤
  │                requests │                31 │                 0 │
  ├─────────────────────────┼───────────────────┼───────────────────┤
  │            test-scripts │                46 │                 0 │
  ├─────────────────────────┼───────────────────┼───────────────────┤
  │      prerequest-scripts │                17 │                 0 │
  ├─────────────────────────┼───────────────────┼───────────────────┤
  │              assertions │               345 │                 0 │
  ├─────────────────────────┴───────────────────┴───────────────────┤
  │ total run duration: 17.5s                                       │
  ├─────────────────────────────────────────────────────────────────┤
  │ total data received: 8.73KB (approx)                            │
  ├─────────────────────────────────────────────────────────────────┤
  │ average response time: 33ms [min: 10ms, max: 150ms, s.d.: 31ms] │
  └─────────────────────────────────────────────────────────────────┘
  ```

golang-grpc-realworld-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README