boateng-api

README

Table of Contents

• Local Setup
  • Requirements
  • Running the API locally
  • Published Ports
  • Viewing the log outputs from the services
• Reporting Bugs
• Reporting Security Issues
• Contributing
• Deploying
• License

Local setup

Requirements

• Docker & Docker Compose
• Visual Studio Code
• A POSIX-compliant terminal, such as:
  • Visual Studio Code terminal
  • cmder
  • Cygwin
  • Bash
  • Zsh

If you're on Linux or Mac, you already have a POSIX-compliant terminal.

Running the API locally

docker-compose up --detach

When running for the first time, you might get this message:

ERROR: The image for the service you're trying to recreate has been removed. If you continue, volume data could be lost. Consider backing up your data before continuing.

Continue with the new image? [yN]

In which case you can go ahead and type y and continue.

To stop the API:

docker-compose down

Published ports

Port numbers published to your host machine.

Port	Service
8800	API
8810	GraphiQL (todo)
8811	Dgraph Ratel
8817	Dgraph Alpha (HTTP)
8818	Dgraph Alpha (gRPC)
8819	Dgraph Zero

Viewing the log outputs from the services

# Displaying all logs.
docker-compose logs

# Displaying logs for the API service.
docker-compose logs api

# Displaying logs for several services, e.g. API and Dgraph Alpha
docker-compose logs api alpha

# Tailing the last 5 lines of the logs from the API service.
docker-compose logs --tail 5 api

# Following the logs for the API service as they come in (CMD/CTRL+C to exit).
docker-compose logs --follow api

# Following the logs for several services as they come in, e.g. Dgraph Alpha and Dgraph Zero.
docker-compose logs --follow api alpha zero

For more details, see the docs or run the command docker-compose logs --help

Reporting Bugs

TODO

Reporting Security Issues

TODO

License

GNU General Public License v3 © Kwahu & Cayes