Client side SDK for frontend development would be great

NewJerseyStyle / LitePolis

LitePolis is a refactored version of [Polis](https://github.com/compdemocracy/polis), built using Python and optimized for scalability and performance.

MIT License

2 stars 0 forks source link

Client side SDK for frontend development would be great #2

Closed NewJerseyStyle closed 4 months ago

NewJerseyStyle commented 6 months ago

For better documentation and simplify developers for developing other front end solution to replace existing Streamlit user interface, a SDK for TypeScript should be developed and the Swagger UI should be tested and enhanced in documentation, many data structure in the FastAPI API endpoint implementations are still unclear which may be a roadblock for other develoepr. It has to be clean up before Beta release

NewJerseyStyle commented 6 months ago

OpenAPI Generator should be considered for client side SDKs

OpenAPI Generator for demo SDK with Streamlit
openapi-ts is good too

Data structure for API endpoint instructions and examples

NewJerseyStyle commented 4 months ago

TODOs:

Test the client SDK
Upload the SDK
Docs about how to gen SDK