spookbite / kwoc20-backend

Go backend for KWOC 20

Directory Structure

MVC Strucutre is being followed.

main.go: Driver Code for all of backend.

models: Database Models

controllers: Various handlers for HTTP Requests

routes: Definitions of Sub-routers

utils: Middlewares and other files common to multiple functions

scripts: Extra scripts (unrelated to the usual flow of the webapp)

docs: Documentation

File Naming Convention

• Separate file for each Model.

• Controller functions to be grouped together by their routes.

• Each Subroute has a separate file.

In short, don't keep any surprises. Use groupings as per your discretion.

Dependencies

gorilla/mux
jinzhu/gorm
dgrijalva/jwt-go

Also uses golanglint-ci for linting code.

Set up

• Clone the repo.

• You can use the Makefile for automating the commands. Run make help for a list of commands.

• Currently, only two(subject to change) commands are supported -

• make lint - Run the lint checks
• make build - For building the codebase

• Run go get to install the dependencies

• Run go run main.go in the terminal

• Run go build to build into a single binary.

• Run gofmt -s -w . to lint all the files in one go.