- 📖 About the Project
- 🔍 Arch Map
- 🛠 Built With
- 🚀 Live OpenAPI Docs
- 💻 Getting Started
- 🤝 Contributing
- 🙏 Acknowledgements
- 📝 License
Gateway is a collection of services that helps make interacting with Frequency as easy as working with any Web2 API!
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
Each Gateway service is an independent microservice.
Account Service
Graph Service
Content Publishing Service
Content Watcher Service
For a more detailed tutorial, visit Live Docs.
To get a local copy up and running, follow these steps.
In order to run this project you need:
Clone this repository to your desired folder:
Clone:
git clone git@github.com:ProjectLibertyLabs/gateway.git
cd gatewayTo run all Gateway services, execute the following command:
./start.shTo stop the Gateway services, execute the following command:
./stop.shTo build the Gateway Documentation:
cd docs
mdbook buildTo build and serve the Gateway Documentation:
cd docs
mdbook serveDeployment 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.
Contributions, issues, and feature requests are welcome!
Thank you to Frequency for assistance and documentation making this possible.
This project is Apache 2.0 licensed.