go-clean-arch

README

Go Clean Architecture Demo

Description

Go Note App is a simple note-taking application built with Go, adhering to the clean architecture principles. It provides a RESTful API for users to create, read, update, and delete notes. The application is containerized using Docker and can be easily deployed and managed using Docker Compose.

Installation

To install and run Go Note App locally, follow these steps:

1. Clone the repository:

git clone https://github.com/nattrio/go-clean-arch.git

1. Navigate to the project directory:

cd go-clean-arch

1. Create a .env file in the project root directory and configure the required environment variables. You can use the provided .env.example file as a template.

2. Build and run the application using Docker Compose:

docker-compose up --build

This command will build the Docker image and start the application and its dependencies (PostgreSQL database) as Docker containers.

1. The Go Note App API should now be accessible at http://localhost:3000. You can send HTTP requests to this endpoint to interact with the application.

Endpoints

The API provides the following endpoints:

• GET /healthchecker: Returns a JSON response with a status and welcome message.
• POST /notes: Creates a new note.
• GET /notes: Retrieves all notes.
• PATCH /notes/:noteId: Updates a note.
• GET /notes/:noteId: Retrieves a specific note.
• DELETE /notes/:noteId: Deletes a note.