store-api

README

Qilin Management API

Qilin is an open-source digital distribution platform for game developers and publishers. Our mission is to distribute games by minimizing the effort of contracting, sharing documentation and providing comprehensive real-time statistics.

Qilin architecture schema

Store API is an API backend server for Qilin Store based on GraphQL schemas.

Features

• TODO

---

Table of Contents

• Requirements
• Development
• Usage
• Testing
• Contributing
• License

Requirements

• Docker
• Docker-Compose
• Git

Development

Display help information

make

Init local env

Should run only once

make up

Generate source files from resource

make generate

Build and run application

It's usage also to rebuild and recreate containers

make dev-build-up

Usage

How to start on Windows

• Install MSYS2 https://www.msys2.org/ and append msys64\usr\bin directory of MSYS2 to the PATH environment variable
• Launch msys2.exe application from msys64 folder
• Execute command pacman -S make mingw64/mingw-w64-x86_64-gcc, then you can close console and use your preffered terminal
• Install docker
• Install go and see Quick Start section below

How to start on Mac, Linux

• Install make, docker
• Install go and see Quick Start section below

Quick Start

• Run make dev-docker-compose-up

• Examine endpoints:

  • GraphQL endpoint: http://localhost:8081/v1/graphql
  • Hasura console: http://localhost:8081/console (usage only as a sandbox)

Contributing, Feature Requests and Support

If you like this project then you can put a ⭐ on it. It means a lot to us.

If you have an idea of how to improve Qilin (or any of the product parts) or have general feedback, you're welcome to submit a feature request.

Chances are, you like what we have already but you may require a custom integration, a special license or something else big and specific to your needs. We're generally open to such conversations.

If you have a question and can't find the answer yourself, you can raise an issue and describe what exactly you're trying to do. We'll do our best to reply in a meaningful time.

Qilin welcomes contributions from anyone and everyone. Please refer to our contribution guide to learn more.

License

The project is available as open source under the terms of the GPL v3 License.