Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/0xataru/simple-blog

REST API for simple blog application
https://github.com/0xataru/simple-blog

crud docker go golang golang-migrate jwt postgres rest rest-api sql swagger taskfile

Last synced: 7 days ago
JSON representation

REST API for simple blog application

Host: GitHub
URL: https://github.com/0xataru/simple-blog
Owner: 0xataru
Created: 2023-03-27T07:47:42.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-06-26T10:57:10.000Z (7 months ago)
Last Synced: 2025-01-02T21:32:34.754Z (14 days ago)
Topics: crud, docker, go, golang, golang-migrate, jwt, postgres, rest, rest-api, sql, swagger, taskfile
Language: Go
Homepage:
Size: 225 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # REST API for Simple Blog Project

[![Go Report Card](https://goreportcard.com/badge/github.com/markraiter/simple-blog)](https://goreportcard.com/report/github.com/markraiter/simple-blog)

### The App:

This is a simple-blog application with jwt authentication and CRUD operations for posts and comments. Only registered users can create posts and comments.

### To run the blog please proceed next:

1. Clone the repository.

2. Install the dependencies with `go mod download`

3. Create `.env` file and copy values from `.env_example`

4. Follow the instructions to install [Taskfile](https://taskfile.dev/ru-ru/installation/) utility

5. Run the app with `task run`

### Running the tests

1. Run the tests with `task test`

2. Also you can proceed with the [OpenAPI](https://swagger.io/) docs by link `localhost:8080/swagger`

### Built With

- [Go](https://golang.org/) - The programming language used.

- [net/http](https://pkg.go.dev/net/http) - Package used for HTTP client and server implementations.

- [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Architectural style for the API.

- [Clean Architecture](https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html) - Architectural pattern used.

- [Postgres](https://www.postgresql.org/) - Database used.

- [Golang-Migrate](https://github.com/golang-migrate/migrate) - Database migrations tool.

- [JWT](https://jwt.io/) - Used for authentication.