Skip to content

Latest commit

 

History

History
58 lines (48 loc) · 1.18 KB

README.md

File metadata and controls

58 lines (48 loc) · 1.18 KB

🪐🌌 Nova 🌌🪐

Template repository to create Go projects

Prerequisites

Before you can build and run this project, ensure you have the following installed on your machine:

  • Go (version 1.23.1+)
  • golangci-lint for linting

Installation

Clone the repository:

git clone git@github.com:senonide/nova.git
cd nova

Install dependencies (if any):

go mod tidy

Install golangci-lint (if not already installed):

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Makefile Commands

The project includes a Makefile that simplifies common tasks. Here are the available commands:

  1. Lint the Code Run static analysis and check the code for potential issues:
make lint

This command uses golangci-lint to perform static analysis and report any issues.

  1. Run Tests Execute all unit tests with the race detector enabled:
make test
  1. Build the Project (Debug Mode) Compile the project with debugging symbols included:
make build-debug
  1. Build the Project (Release Mode) Compile the project for production:
make build
  1. Run the Project Run the project directly:
make run