internet-chowkidar

README

Internet Chowkidar

This repository contains the code for internet chowkidar, a web application that allows users to monitor any blocks, bans, or restrictions on the internet by their ISP. The application is built using Go and PostgreSQL.

Features

• Logging: Structured logging with slog
• Configuration: Configuration management with koanf
• HTTP Server: HTTP server with net/http
• Database: DB ORM with ent
• Task Runner: Task runner with just

Requirements

• Go >= 1.21.5
• redocly (generate API documentation)
• ent (DB ORM)
• goose (DB migrations tool)
• ogen (generate APIs)
• wire (dependency injection)
• just (task runner)

Quickstart

1. Clone the repository
2. Install the dependencies

go mod tidy

1. Set up local environment variables using the .env.example file.

cp .env.example .env

1. Run codegen

just # yes, that's it, nothing else

1. Run the application

just run

Codegen

Necessary for generating APIs, DB schemas, dependency injection, etc. A detailed explanation of the codegen process can be found here.

Devcontainers

This repository contains a devcontainer configuration for Visual Studio Code. The devcontainer is pre-configured with all the necessary tools and extensions to start developing right away. A detailed explanation of the devcontainer can be found here.

Migrations

Refer to the migrations documentation for more information on how to create and apply migrations.