README.md

Blogify

A blogging platform API to share what is in my mind

Table of content

• Installation
• Usage
• Features
• Contributing
• License
• Acknowledgments

Installation

1. Clone the repository:

git clone https://github.com/hyprhex/blogify.git

2. Navigate to the project

cd blogify

3. Install dependencies

# Handle routing
go get github.com/go-chi/chi/v5
go get github.com/go-chi/chi/v5/middleware

# Needed to connect with the database
go get github.com/lib/pq

# To validate user inputs
go get github.com/go-playground/validator/v10

Install CLI tools

• To migrate file I use : golang-migrate
• To get env variable : direnv
• To reload server on change: air

Install docker

• Install docker and docker-compose Here

Usage

1. Build docker compose

sudo docker compose up --build

2. Run the server

air

Features

• Straightforward Bloggin platform
• No authentication
• Easy to test

Contributing

Contributions are welcome! just submit your pull requests and I will handle it.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Inspiration: Thanks to roadmap
• Tools: Project built using Go, PostgreSQL