gateway

README

VN Gateway

This project is a gateway for the VN project. It is responsible for handling all the incoming requests and routing them to the appropriate services. It also handles the authentication and authorization of the requests. The gateway is built on top of the Go programming language and uses the Fiber framework.

Project structure

The project follows the standard Go project layout. The structure of the project is as follows:

.
├── .github                     # GitHub actions workflows
├── .golangci.yml
├── Dockerfile
├── Makefile
├── README.md
├── cmd
│   └── gateway
│       └── main.go
├── docs
├── go.mod
├── go.sum
├── internal
│   ├── config
│   ├── middleware
│   ├── models
│   ├── routes
│   ├── service
│   ├── tools
│   └── utils
├── scripts
└── test

Prerequisites installation

• Install Node.js (v.20.13.1+) or via nvm
• Install Go 1.22.3+
• Install Docker Desktop
• (For Windows users) Install WSL2
• (For Windows users) Install Chocolatey and then run choco install make to install make command
• Install golangci-lint and
  • Set up IDE integration (see instructions). This is optional because it may cause performance issues in some IDEs. You are still can run make check to lint your code instead.

Prepare the environment

1. Run npm run install to install the project dependencies

⚠️ Pre-commit ⚠️

Make sure you have already run make lint before committing your code. This will ensure that your code is properly formatted and passes all the tests.