Code Monkey home page Code Monkey logo

base-api-go's Introduction

gopherbadger-tag-do-not-edit

Go + Iris - Base API

This is an example API, built with Go and Iris. The codebase was created to show a working backend application in Go, with different options of database clients.

Table of Contents

  1. How it works
  2. Getting started
  3. Additional

How it works

The repository is organized in 3 different branches:

  • master
  • bun
  • pgx
  • sqlx

master

The master branch contains only the file structres and example controllers. No DB, just the Iris framework.

Iris is a fast, simple yet fully featured and very efficient web framework for Go. It provides a beautifully expressive and easy to use foundation for your next website or API.

Simple and performant DB client for PostgreSQL, MySQL, and SQLite.

pgx is a pure Go driver and toolkit for PostgreSQL.

sqlx is a library which provides a set of extensions on go's standard database/sql library.

Getting started

Running for development

make run

Building the app

Building just for current OS

make build

Buiding for multiple distributions

make build-all

Testing the app

make test

Additional

Generating coverage in HTML

make cover-html

Generating badge

Everytime you call make test or make cover-html, the badge in README.md gets updated, but you can do it manually:

make badge

Cleaning the repo

make clean

Feel free to contribute.

Made with โค in Brazil

The logo is from @ashleymcnamara and can be found here.

base-api-go's People

Contributors

un-versed avatar pauloleal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.