Skip to content

Latest commit

 

History

History
121 lines (81 loc) · 3.23 KB

README.md

File metadata and controls

121 lines (81 loc) · 3.23 KB
Raw

Rarime Link Service

Rarime Link Service stores users proofs and provide simple access to it via REST API in JSON:API format.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

Building

Binary

To build the service binary file, follow these steps:

  1. Clone the repository.

    git clone github.com/rarimo/rarime-link-svc
cd rarime-link-svc

  2. Install dependencies and build the service.

    go mod tidy
go build main.go

Docker

To build the service Docker image, follow these steps:

  1. Clone the repository.

    git clone github.com/rarimo/rarime-link-svc
cd rarime-link-svc

  2. Build the service image.

    sh ./build.sh

Configuration

To properly configure the service, provide valid config file, see config-example.yaml for example.

Running with Docker

To run the service using Docker, follow these steps:

  1. Build the service image, see Building.

  2. Run the service image.

    docker-compose up -d

  3. The service will be available on the 8000 port.

Usage

To use the service, you could use the swagger documentation, see API Documentation, or any other http client.

API Documentation

We use openapi:json standard for API. We use swagger for documenting our API.

To open online documentation, go to swagger editor, here is how you can start it

  cd docs
  npm install
  npm start

To build documentation use npm run build command, that will create open-api documentation in web_deploy folder.

To generate resources for Go models run ./generate.sh script in root folder. use ./generate.sh --help to see all available options.

Contributing

We welcome contributions from the community! To contribute to this project, follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your branch on your GitHub fork.
  5. Create a pull request from your branch to the main branch of this repository.

Please ensure your pull request adheres to the following guidelines:

  • Add a clear pull request title;
  • Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;
  • Update the CHANGELOG.md accordingly;
  • Keep the codebase clean and well-documented;
  • Make sure your code is properly tested;
  • Reference any related issues in your pull request;

The maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!

Changelog

For the changelog, see CHANGELOG.md.

License

This project is under the MIT License - see the LICENSE file for details.