Group Tree API

An awesome GraphQL API built for multi-level tree groups using postgres B-Tree structure.
B-Tree Structure »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running
3. Documentation
4. Contact

About The Project

Built With

This service is built based on the following technologies

• NodeJS
• TypeScript
• GraphQL

Getting Started

Prerequisites

Skip this step if you choose to use docker-compose.

• Postgres DB
• Redis

Installation

1. Clone the repo

   git clone https://github.com/augustoam/group-tree

2. Use the package manager npm or yarn to install the dependencies.

   npm install

3. Create a copy of .env.example and name it .env in this directory. Fill in the requested variables.

Running

Run with Docker Compose

docker-compose up -d

Without Docker Compose

1. Compile the project

   npm run compile

2. Start the server

   npm start

Documentation

You can find a full complete API documentation here. This documentation is generated by using a library called dociql which provides a beautiful static HTML based on a graphql introspection query. The HTML pages and the config file used by dociql can be found inside the docs folder.

You can also find a GraphQL playground in the endpoint http://localhost:4000/.

Contact

Augusto Pedrollo Albertoni - augusto.albertoni@gmail.com