https://github.com/victorsteven/forum-app-go-backend

Forum Backend API built with Golang, GIn Framework, GORM, PostgreSQL/MySQL
https://github.com/victorsteven/forum-app-go-backend

gin gin-gonic go golang gorm gorm-orm mysql postgresql

Last synced: 4 days ago
JSON representation

Forum Backend API built with Golang, GIn Framework, GORM, PostgreSQL/MySQL

• Host: GitHub
• URL: https://github.com/victorsteven/forum-app-go-backend
• Owner: victorsteven
• Created: 2019-09-15T20:30:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T04:00:05.000Z (almost 2 years ago)
• Last Synced: 2025-01-16T23:03:04.680Z (4 days ago)
• Topics: gin, gin-gonic, go, golang, gorm, gorm-orm, mysql, postgresql
• Language: Go
• Homepage:
• Size: 351 MB
• Stars: 203
• Watchers: 9
• Forks: 57
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Forum-App-Go-Backend  [![CircleCI](https://circleci.com/gh/victorsteven/Forum-App-Go-Backend.svg?style=svg)](https://circleci.com/gh/victorsteven/Forum-App-Go-Backend)

 

> This is a forum API built with Golang

## Getting Started

> [[Technologies](#technologies-used) ·  · [Installations](#installations) · · [Tests](#tests) · [Author](#author)

## Technologies Used

[golang]: (https://golang.org)

- [Golang](https://golang.org).

- [Gin Framework](https://github.com/gin-gonic/gin).

- [GORM](http://gorm.io).

- [postgreSQL](https://www.postgresql.org).

- [Docker](https://www.docker.com/).

- [Digital Ocean](https://www.digitalocean.com).

- [AWS](https://aws.amazon.com).

- [Circleci](https://circleci.com).

## Installations

### Clone

- Clone this project to your local machine `https://github.com/victorsteven/Forum-App-Go-Backend.git`

### Setup

  #### Without Docker

  > Ensure that you have your .env set up and have created your database

  - For local, set the DB_HOST in the .env file as follows:

    ```shell

      $ DB_HOST=127.0.0.1

    ```           

  > In the root directory, run the command

  ```shell

  $ go run main.go

  ```

  - Use `http://localhost:8080` as base url for endpoints

 #### Using Docker

  Docker is the default setting for this project

  - Set the DB_HOST as follows in the .env file

    ```shell

      $ DB_HOST=forum-postgres 

    ```    

  ##### For Local Development:

  - Create a Dockerfile file in the root directory

  - Copy the content of the file: example.Dockerfile.dev (for only local development)

  - Create a docker-compose.yml file in the root directory

  - Copy the content of the file: example.docker-compose.dev.yml (for only local development)

  ##### For Testing:

  - Create a Dockerfile.test file in the root directory

  - Copy the content of the file: example.Dockerfile.test (for only test)

  - Create a docker-compose.test.yml file in the root directory

  - Copy the content of the file: example.docker-compose.test.yml (for only test)

  

  ##### For Production (This should be done in the server (AWS, DigitalOcean, etc)):

  - Create a Dockerfile file in the root directory

  - Copy the content of the file: example.Dockerfile.prod (for production only)

  - Create a docker-compose.yml file in the root directory

  - Copy the content of the file: example.docker-compose.prod.yml (for production only)

  

  In the root directory, run the command:

  ```shell

  $ docker-compose up --build

  ```

  - Use `http://localhost:8888` as base url for endpoints

## Tests

  ### Without Docker

  - Run test for all endpoints

    > Navigate to the tests directory and run

    ```shell

    $ go test -v ./...

    ```

  ### Using Docker

- Run test for all endpoints

  > If you have set up the Dockerfile.test and the docker-compose.test.yml files above, from the root directory of the app.

  ```shell

  $ docker-compose -f docker-compose.test.yml up --build 

  ```

## Author

- Steven Victor

- medium: medium.com/@victorsteven  

- twitter: twitter.com/stevensunflash  

- linkedin: linkedin.com/in/stevenchikodi