Gateway

📗 Table of Contents

📖 About the Project
🔍 Arch Map
🛠 Built With
- Tech Stack
🚀 Live OpenAPI Docs
💻 Getting Started
- Prerequisites
- Setup
- Usage
- Deployment
🤝 Contributing
🙏 Acknowledgements
📝 License

📖 Gateway Services

Gateway is a collection of services that helps make interacting with Frequency as easy as working with any Web2 API!

🔭 Arch Maps

Overview Gateway Services

flowchart LR;
    subgraph Custom Logic
        C[Client] --> S(Server)
    end
    subgraph Gateway Microservices
        AS[Account Service]
        GS[Graph Service]
        CPS[Content Publishing Service]
        CWS[Content Watcher Service]
    end
    S --> AS
    S --> GS
    S --> CPS
    S --> CWS
    S --> RS
    subgraph Public
        F(Frequency Network)
    end
    AS --> F
    GS --> F
    CPS --> F
    CWS --> F
    RS --> F

(back to top)

🛠 Built With

Each Gateway service is an independent microservice.

Tech Stack

Account Service

Graph Service

Content Publishing Service

Content Watcher Service

🚀 Live Docs

Live Docs

(back to top)

💻 Getting Started

For a more detailed tutorial, visit Live Docs.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Docker or Docker compatible layer for running Gateway Services
mdBook for building documentation

Setup

Clone this repository to your desired folder:

Clone:

  git clone git@github.com:ProjectLibertyLabs/gateway.git
  cd gateway

Usage

To run all Gateway services, execute the following command:

  ./start.sh

To stop the Gateway services, execute the following command:

  ./stop.sh

To build the Gateway Documentation:

  cd docs
  mdbook build

To build and serve the Gateway Documentation:

  cd docs
  mdbook serve

Deployment

Deployment of the Gateway services have various options. See the Live Docs for more details.

Deployment of the Gateway documentation occurs via merge to main branch via GitHub Actions.

ProjectLibertyLabs/gateway