csv2json

Fast, simple, and extensible CSV to JSON converter for developers with PostgreSQL integration.

This is the public repository containing installation steps, usage examples, and documentation

Video Demo

📹 Watch the project demo

Features

• Upload CSV files via REST API
• Automatic CSV to JSON conversion
• PostgreSQL database storage for all converted data
• JSONB support for efficient querying
• Connection pooling and optimized database operations
• Standalone Go package for programmatic use

For reference

Prerequisites

• Go 1.24 or higher
• PostgreSQL 12 or higher

Database Setup

1. Install PostgreSQL if not already installed
2. Create a database for the application:

CREATE DATABASE csv2json;

3. Configure database connection using environment variables (see .env.example)

The application will automatically create the required tables on startup.

Installation

As a Go Package

go get github.com/agileproject-gurpreet/csv2json

For Local Development

1. Clone the repository:

git clone https://github.com/agileproject-gurpreet/csv2json.git
cd csv2json

2. Install dependencies:

go mod download

3. Set up environment variables:

cp .env.example .env
# Edit .env with your PostgreSQL credentials

4. Run the application:

go run cmd/api/main.go

Usage as Go Package

package main

import (
	"fmt"
	"log"

	"github.com/agileproject-gurpreet/csv2json/pkg/csv2jsonx"
)

func main() {
	// Convert a CSV file to JSON
	jsonData, err := csv2jsonx.ConvertFile("sample.csv")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(jsonData))

	// Or convert from an io.Reader
	// jsonData, err := csv2jsonx.ConvertReader(reader)
}

For Local Development with Replace Directive

If you're developing locally and want to use the local version of the module, add this to your go.mod:

replace github.com/agileproject-gurpreet/csv2json => ../path/to/csv2json

Environment Variables

Variable	Description	Default
DB_HOST	PostgreSQL host	localhost
DB_PORT	PostgreSQL port	5432
DB_USER	Database user	postgres
DB_PASSWORD	Database password	postgres
DB_NAME	Database name	csv2json
DB_SSLMODE	SSL mode for connection	disable
PORT	Server port	8080

API Endpoints

Upload CSV

POST /api/upload
Content-Type: multipart/form-data

Upload a CSV file and convert it to JSON. The data is automatically saved to PostgreSQL.

Example:

curl -X POST http://localhost:8080/api/upload \
  -F "file=@sample.csv"

Response:

[
  {
    "column1": "value1",
    "column2": "value2"
  }
]

Get All Data

GET /api/data

Retrieve all stored CSV data from the database.

Example:

curl http://localhost:8080/api/data

Response:

[
  {
    "id": 1,
    "filename": "sample.csv",
    "data": [...],
    "created_at": "2026-01-27T10:30:00Z"
  }
]

Get Data by ID

GET /api/data/id?id={id}

Retrieve a specific CSV data record by its ID.

Example:

curl http://localhost:8080/api/data/id?id=1

Response:

{
  "id": 1,
  "filename": "sample.csv",
  "data": [...],
  "created_at": "2026-01-27T10:30:00Z"
}

Health Check

GET /api/health

Check if the API is running.

Response:

{
  "status": "healthy"
}

Database Schema

The application creates the following table:

CREATE TABLE csv_data (
    id SERIAL PRIMARY KEY,
    filename VARCHAR(255),
    data JSONB NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

The data column stores the converted JSON data as JSONB, allowing for efficient querying and indexing.

Development

Run tests:

go test ./...

License

See LICENSE file for details.