gofus-manager

README

Gofus-Manager

Gofus-Manager is the Gofus component in charge of answering Gofus-Dashboard requests.

The code is auto-generated by go-swagger from an OpenApi V2 Specification file (formerly swagger).

The reference API specification file is available in Gofus-API repository.

---

Quick Start with latest docker image

• Prerequisites
  • Docker

$ docker run -p 5000:5000 registry.gitlab.com/gofus/gofus-manager/dev:latest
Serving gofus at http://[::]:5000

The manager is available to use at http://localhost:5000.

Try retrieving the list of accounts with your browser at http://localhost:5000/accounts.

You should receive an empty list.

You can also bind it to another port:

$ docker run -p 3000:5000 registry.gitlab.com/gofus/gofus-manager/dev:latest
Serving gofus at http://[::]:5000

The manager available to use at http://localhost:3000.

---

Build and run from sources

Installation

• Prerequisites
  • Git

Clone with SSH or HTTPS:

$ git clone git@gitlab.com:gofus/gofus-manager.git
OR
$ git clone https://gitlab.com/gofus/gofus-manager.git

Compilation

• Prerequisites
  • Go >= 1.12

$ cd gofus-manager/cmd/gofus-server
$ go build

Usage

$ ./gofus-server
Serving gofus at http://127.0.0.1:5000

You can also listen on a specific port using PORT environment variable:

$ PORT=5001 ./gofus-server
Serving gofus at http://127.0.0.1:5001

---

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Tests and Coverage

Please make sure to update tests as appropriate. Use the tests and coverage script before pushing to the repository:

$ cd gofus-manager
$ ./launchTestsAndCoverage.sh

Updating Gofus-Manager after Gofus-API modifications

• Prerequisites

  • go-swagger binary named 'go-swagger' available in your system ($PATH or /usr/local/bin)
  • Gofus-API repository in the same place as Gofus-Manager repository in your filesystem.

  Example:

  $ go-swagger version
  version: v0.21.0
  commit: 7c0fc3ee340f9d99d85573bc54a57e303a639692
  
  $ ls
  └─── gofus-manager
  └─── gofus-api
  

Usage

$ cd gofus-manager
$ ./updateFromApiFile.sh

Community tools

Join us on Discord !

Check our Trello ! Team Invitation Link

Have a look at the Gofus Proposal specification document (wip) to learn more about the project.

License

MIT