Mango2019-API

command module
v0.0.0-...-cd49cae Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2018 License: MIT Imports: 2 Imported by: 0

README

MangoHacks 2019 Bandage Travis Build Badge Go Report Card GoDoc

Mango2019-API

This is the backend of 2019's MangoHacks, herein, all database functionality and most data manipulation events will occur.

The API is built with scalability in mind and is able to be scaled horizontally with ease.

Shoutout to Google for letting us deploy on Google Cloud Kubernetes Engine, allowing us to build ridiculously resilient software. Love you guys!

Running/Testing The Server

  1. $ git clone the repository into your $GOPATH.
  2. $ go build the binary within the directory the repository was cloned to.
  3. $ ./Mango2019-API to run the binary.

Documentation

Overview

Package main initializes and runs the server. This package is small, because it is main.

Directories

Path Synopsis
Package database deals with the initialization of our database connection.
Package database deals with the initialization of our database connection.
Package models contains the structures of data which is stored in the database and sent and received via HTTP requests.
Package models contains the structures of data which is stored in the database and sent and received via HTTP requests.
Package routes deals with the execution of requests to different routes.
Package routes deals with the execution of requests to different routes.
Package server deals with the initialization of the server as well as the listening and handling of resources.
Package server deals with the initialization of the server as well as the listening and handling of resources.
Package web contains many functions and structs that are common to applications and services that interact via the internet.
Package web contains many functions and structs that are common to applications and services that interact via the internet.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL