expressots/scylladb-driver-old

The ScyllaDB driver for Node.js written in C++ 🚀

ExpressoTS Framework

Everything you need to know to build applications with ExpressoTS
Explore the docs »

Let's discuss · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Contributing
4. Support the project
5. License

About The Project

ExpressoTS is a Typescript + Node.js lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🐎

Getting Started

• Here is our Site
• You can find our Documentation here
• Checkout our First Steps documentation
• Our CLI Documentation

Contributing

Welcome to the ExpressoTS community, a place bustling with innovative minds just like yours. We're absolutely thrilled to have you here! ExpressoTS is more than just a TypeScript framework; it's a collective effort by developers who are passionate about creating a more efficient, secure, and robust web ecosystem. We firmly believe that the best ideas come from a diversity of perspectives, backgrounds, and skills.

Why Contribute to Documentation?

• Share Knowledge: If you've figured out something cool, why keep it to yourself?
• Build Your Portfolio: Contributing to an open-source project like ExpressoTS is a great way to showcase your skills.
• Join a Network: Get to know a community of like-minded developers.
• Improve the Product: Help us fill in the gaps, correct errors, or make complex topics easier to understand.

Ready to contribute?

• Contributing Guidelines
• How to Contribute
• Coding Guidelines

Support the project

ExpressoTS is an independent open source project with ongoing development made possible thanks to your support. If you'd like to help, please consider:

• Become a sponsor on GitHub
• Follow the organization on GitHub and Star ⭐ the project
• Subscribe to the Twitch channel: Richard Zampieri
• Join our Discord
• Contribute submitting issues and pull requests
• Share the project with your friends and colleagues

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

scylladb-driver-old's Issues

Modularize the Current Code Structure for Improved Maintainability

Problem

The current code structure in the src directory is organized under a single file lib.rs. While this approach might have been suitable for smaller projects, as our codebase grows, it becomes increasingly important to adopt a more modular and maintainable structure.

src
└── lib.rs

Solution

To address this, we should reorganize the codebase by introducing a modular approach. This would involve dividing the code into smaller, focused modules, each responsible for a specific functionality or feature. This will enhance code readability, improve collaboration among developers, and make it easier to manage and maintain the codebase in the long run.

src
├── lib.rs
├── cluster
│   ├── mod.rs
│   ├── cluster.rs
│   └── cluster_config.rs
└── session
    ├── mod.rs
    └── scylla_session.rs

In this updated structure, we have two main modules: cluster and session. Here's a breakdown of each module:

1. cluster Module:
   1.1. mod.rs: This file acts as the module's entry point and defines the module's public interface.
   1.2. cluster.rs: This file contains the implementation of the Cluster struct and its associated methods.
   1.3. cluster_config.rs: This file defines the ### ClusterConfig struct and its associated functions.
2. session Module:
   2.1. mod.rs: This file acts as the module's entry point and defines the module's public interface.
   2.2. scylla_session.rs: This file contains the implementation of the ScyllaSession struct and its associated methods.

The lib.rs file serves as the entry point for the application and can import and use the modules defined in the src directory.