Git Product home page Git Product logo

connect-authx's Introduction

connect-authx

Installing dependencies

$ go install github.com/swaggo/swag/cmd/swag

Compiling

$ make distclean && make docs && make

Building Docker image

$ make docker-build

Pushing Docker image to Container Registry

Note that only the owner of the repository is allowed to push the image.

$ make docker-push

Running

For local environment

Run connect-infra

$ git clone https://github.com/mrexmelle/connect-infra
$ cd connect-infra
$ docker compose up

Run local service

$ ./connect-authx serve

For docker environment

Run connect-infra

$ git clone https://github.com/mrexmelle/connect-infra
$ cd connect-infra
$ docker compose up

Run service in docker

$ make docker-build
$ docker compose up

Note that you cannot alter the docker image in the container registry. Only the owner of the repository is allowed to do so.

If error happens in core service due to failure to connect to database, restart it:

$ docker compose restart core

The failure might happen due to database service isn't ready when core attempts to connect to it.

API Documentation

Once the service runs, the API documentation is available in $HOST:$PORT/swagger/index.html

Note that the API documentation is only available if the service is run with local profile, i.e. when either APP_PROFILE environment is defined as local or undefined.

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.