How 0xmerso/tycho-orderbook-web works
• Frontend: Represent the open‐source NextJS frontend which handles user interactions and visualization. Label it clearly as “Frontend (NextJS)”.
• Backend: Represent the Rust API built with Axum. Label it “Backend API (Rust, Axum)”.
• Shared Backend Modules: Within the backend, break out internal modules (as seen in the “back/src/shared” folder) such as “data”, “getters”, “helpers”, “misc”, “types”, and the “axum” entry point. These modules encapsulate business logic and helper functionalities.
• Within the backend, show the interdependency between the main API entry point (axum.rs) and the shared modules. This highlights that the API logic is built upon these modular components.
Architectural patterns and design principles
• Separation of Concerns: Demonstrated by splitting the project into a frontend and backend.
• Modular Design: In the backend, emphasize the shared library (various helper and utility modules) which promotes code reuse and maintainability.
• Containerization & Automation: The presence of Docker files and shell scripts indicates that the application is meant to be easily deployable and tested in a controlled environment.
Relevant technologies and frameworks
• Frontend: NextJS which facilitates server-side rendering and a rich UI experience.
• Backend: Rust language with the Axum framework, emphasizing high-performance API handling.
• Docker: Containerization and orchestration via docker-compose for integration and testing.
• Additional tooling: Rust configuration files (Cargo.toml, rustfmt.toml) that emphasize code style and package management.