xfrr/gophersys

A simple CRUD application to manage Gopher entities written in Go.

Go

Gophersys

A simple CRUD application built with Go, Chi, and MongoDB to manage Gophers.

📝 Table of Contents

📝 Table of Contents
🏁 Getting Started
- Prerequisites
  - Development Tools
  - Deployment Tools
- Installing
🎈 Usage
🚀 Deployment
- Deploy using Docker
- Deploy using Kubernetes and Helm
📝 License

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Go >= 1.22 - Programming Language
MongoDB >= 8.0 - Database for persistence

Development Tools

Go Air - Live Reloading
Protoc >= 3.0 - Protocol Buffers Compiler

Deployment Tools

Docker 24.0 or higher - Containerization
Kubernetes 1.27 or higher - Container Orchestration
Helm 3.0 or higher - Kubernetes Package Manager

Installing

Clone the repository

git clone https://github.com/xfrr/gophersys.git

Change directory to the project folder and setup the environment
```
cd gophersys && make setup
```
This will install all the dependencies required for development.

🎈 Usage

Running the application locally

Start the application using one of the following commands:

# using go run
make run

# using https://github.com/air-verse/air
# for live reloading
make run-air

Running the application using Docker

Start the application using the following command:

  make run-docker

Accessing the application

Navigate to http://localhost:8080 in your browser

Cleaning the application

To clean up all development resources, run the following command:

make purge

🚀 Deployment

Deploy using Docker

Build the Docker image
```
make build-docker
```
Run the Docker container using docker-compose
```
make run-docker
```
Navigate to http://localhost:8080 in your browser

Deploy using Kubernetes and Helm

Install the application using Helm
```
make install-helm
```
Uninstall the application using Helm
```
make uninstall-helm
```

📝 License

This project is MIT licensed.