palamardev/blog-backend repository overview

⁠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

/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:

git clone https://github.com/aleksanderpalamar/blog-backend.git
cd blog-backend

Install dependencies:

go mod download

or

go mod tidy

⁠Running the application:

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⁠

⁠Author:

Aleksander Palamar⁠

⁠License

This project is licensed under the MIT License⁠ file for details.