An open API service indexing awesome lists of open source software.

https://github.com/escalopa/goblog

Restful CRUD API, Built with golang
https://github.com/escalopa/goblog

crud-api golang practice

Last synced: 2 months ago
JSON representation

Restful CRUD API, Built with golang

Awesome Lists containing this project

README

        

# GoBlog

## About

This repo is a pure practice for go principlies to improve my skills.

## Packages Used

- viper
- mux
- gorm
- docker-compose

## API Usage

### Remote Instance

The application is deployed on heroku. You can access the API at [GoBlog Remote Server](http://37.46.128.188/goblog/docs/index.html)

### Local Instance

To run the local instance, you first have to set up the env vars, You can use the default ones in the `.*.env.example`.

```bash
cp .env.example .env
cp .db.env.example .db.env
```

Run the following command to start the application.

```bash
docker compose up
```

Then navigate to [Local Instance](http://localhost:9000/docs/index.html) to see the API in action.