Giter VIP home page Giter VIP logo

go-gin's Introduction

go gin

Project to practice and familiarise with Golang and the Gin Web Framework. Also implementing Server-sent-events.

Requirements

  • Go
  • Docker

Starting the project

First of all, start the database by running:

docker compose up -d

Then, run the following commands to start the Go app:

cd app/
cp .env.example .env
go get .
go run .

Seeding the database

In the app directory, run one of these commands to populate the database:

    go run seeds/*

Or

    make seeds

This will create two user accounts:

email Password Role
[email protected] User123+= USER
[email protected] Admin123+= ADMIN

Routes documentation

You can use Swagger to display and try all available routes, along with the corresponding parameters and response format. The url should be http://localhost:3000/swagger/index.html unless you've changed the default port or you set the GIN_MODE to "release".

The library used to do this is gin-swagger.

Note: to update swagger you'll have to run in /app swag init.

go-gin's People

Contributors

jsaleix avatar

Watchers

 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.