VidyarthiDesk - Backend

Backend of VidyarthiDesk ERP Software. Built with Go and Fiber.

Getting Started

Prerequisites

• Go 1.25
• Git
• PostgreSQL

Installation

Install the dependencies:

go mod tidy

Development

Migrate Database

make up # Apply latest migrations
make down # Rollback to version 1
make up-by-one # Migrate DB up by 1
make down-by-one # Migrate DB down by 1

Seed Database

make seed

Build

make build

Run

make run

Environment Variables

Copy .env.example to .env and update as needed:

PORT=3000
JWT_SECRET=supersecret
GOOSE_DRIVER=postgres
GOOSE_DBSTRING=postgres://user:pass@localhost:5432/nttf?sslmode=disable
GOOSE_MIGRATION_DIR=./database/migrations

Features

• 🚀 Fast HTTP server with Fiber v3
• 🛑 Graceful shutdown on Ctrl+C (SIGINT / SIGTERM)
• 🔌 Middleware support (CORS included by default)
• 📂 Organized project structure with cmd/ and server/

Contributing

1. Fork the project
2. Clone the fork

   git clone https://github.com/<username>/nttf-erp-backend.git

3. Add Upstream

   git remote add upstream https://github.com/Keracode/vidyarthidesk-backend.git

4. Create a new branch

   git checkout -b feature

5. Make your changes
6. Commit your changes

   git commit -am "Add new feature"

7. Update main

   git checkout main
   git pull upstream main

8. Rebase to main

   git checkout feature
   git rebase main

9. Push to the branch

   git push origin feature

10. Create a new Pull Request

LICENSE

The GPLv3 License (GPLv3)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.