Develop
July 4, 2024Less than 1 minute
Develop
Overview
The development section of RocksDBFusion provides guidelines and tools for contributing to the project, generating client code, and understanding the schema definitions used in the project.
Sections
Code Generation
Learn how to use the code generation tools to create clients for different programming languages. This includes instructions on how to add new languages and integrate them into the build process.
Schema Definition
Understand the schema definitions used in RocksDBFusion. This section explains how to generate the schema from the server code and how to use it for client code generation.
Features
- Generator Scripts: Tools to generate client code from schema definitions.
- Schema Definitions: Detailed schema for database operations.
- Contribution Guidelines: How to contribute to the project, report issues, and request features.
How to Get Started
- Code Generation: Follow the instructions in the generator.md to generate client code for new languages.
- Schema Definition: Use the
npm run schema
command to generate the JSON schema from the server comments.
Contribution
We welcome contributions from the community. Please read our contribution guidelines before submitting any pull requests or issues.