Categorygithub.com/sakthiRathinam/chirpy
modulepackage
0.0.0-20240722182303-62a9beb20757
Repository: https://github.com/sakthirathinam/chirpy.git
Documentation: pkg.go.dev

# README

chirpy

Chirpy is a social network similar to Twitter.

Prerequisites

Ensure you have the following tools installed:

  • Air - Live reload for Go applications.
  • gofmt - Go source code formatter (comes with the Go toolchain).
  • Docker Compose - Define and run multi-container Docker applications.

Makefile Commands

make help

Displays the help message with the list of available commands.

make help

make watch

Uses Air to watch for file changes and rebuild the Go project.

make watch

make lint

Runs gofmt on all Go files to check and correct formatting.

make lint

make docker-watch

Runs docker-compose up --build to build and start the Docker containers.

make docker-watch

make docker-build

Runs docker-compose build to build the Docker containers.

make docker-build

make check-tools

Ensures that air and gofmt are installed before running any commands.

make check-tools

Usage

Clone the repository and navigate to the project directory:

git clone <repository-url>
cd <project-directory>

Run any of the make commands listed above to perform the respective actions. For example, to watch for file changes and rebuild the Go project:

make watch

License

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

# Structs

No description provided by the author