Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleksanderpalamar/blog-backend
This project is a backend for a blog application written in GoLang. It provides a complete CRUD (Create, Read, Update, Delete) functionality for managing blog posts. The project uses GORM for ORM and Postgres as the database.
https://github.com/aleksanderpalamar/blog-backend
docker docker-compose gogin golang gorm postgresql
Last synced: 13 days ago
JSON representation
This project is a backend for a blog application written in GoLang. It provides a complete CRUD (Create, Read, Update, Delete) functionality for managing blog posts. The project uses GORM for ORM and Postgres as the database.
- Host: GitHub
- URL: https://github.com/aleksanderpalamar/blog-backend
- Owner: aleksanderpalamar
- License: mit
- Created: 2024-06-03T14:44:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T13:39:39.000Z (8 months ago)
- Last Synced: 2025-01-27T04:27:33.328Z (15 days ago)
- Topics: docker, docker-compose, gogin, golang, gorm, postgresql
- Language: Go
- Homepage: https://hub.docker.com/r/palamardev/blog-backend
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blog Backend API
This project is a backend for a blog application written in GoLang. It provides a complete CRUD (Create, Read, Update, Delete) functionality for managing blog posts. The project uses GORM for ORM and SQLite as the database.
## Project Structure
```bash
/blog
/main.go
/routes
/routes.go
/models
/post.go
/comment.go
/user.go
/controllers
/post_controller.go
/comment_controller.go
/user_controller.go
/config
/database.go
/middleware
/auth.go
```
## Getting Started
### Prerequisites
- Go installed on your machine.
- SQLite installed (or any other database supported by GORM, but make sure to adjust the connection settings).
- `.env` file with the necessary environment variables (e.g., `PORT`).
**Installing**
Clone the repository:
```bash
git clone https://github.com/aleksanderpalamar/blog-backend.git
cd blog-backend
```
Install dependencies:
```bash
go mod download
```
or
```bash
go mod tidy
```
## Running the application:
```bash
go run main.go
```
The server will start at `http://localhost:8080` (or the port specified in your `.env` file).
## Docker and Docker Compose
This project includes a Dockerfile and docker-compose.yml file to help you manage common task more easily. Here's a list of the available commands and a brief description of what they do:
- `docker compose up --build`: Builds the Docker image and starts the containers.
- `docker compose down`: Stops and removes the containers.
### API Endpoints
- GET `/posts`: Retrieve all blog posts.
- GET `/posts/:i`: Retrieve a single blog post by ID.
- POST `/posts`: Create a new blog post.
- PUT `/posts/:id`: Update an existing blog post by ID.
- DELETE `/posts/:id`: Delete a blog post by ID
### API Documentation
[API Documentation](https://github.com/aleksanderpalamar/blog-backend/blob/main/docs/api.md)
### Author:
[Aleksander Palamar](https://aleksanderpalamar.dev)
### License
This project is licensed under the [MIT License](https://github.com/aleksanderpalamar/blog-backend/blob/main/LICENSE) file for details.