The alephium-stats-client repository serves as a Proof of Concept demonstrating the basic functionalities and structure of the backend system, which is responsible for serving data and handling requests from the client application.
This repository showcases how to interact with the backend system and provides examples of how to utilize the endpoints exposed by the backend.
To generate the client, follow these steps:
- Navigate to the root backend directory.
- Ensure all necessary dependencies are installed (lets, openapi-generator-cli)
- Use the command
lets clientto generate the client.
All open endpoints and their functionalities can be found in the documentation. These endpoints serve as the entry points for interacting with the backend. Since this is only a proof of concept, the system is designed to be easily extensible. You can add new endpoints to fulfill additional functionalities as needed.
- Backend Repository: Link to the backend repository for further reference.
- documentation: Detailed documentation of the backend API endpoints.