Skip to main content

Quickstart

Follow these steps to quickly get started:

  1. Explore the Notebooks

    Visit Colab Notebooks to explore our interactive notebooks and get a feel for what SuperDuperDB has to offer. For a high-level overview of our framework, visit our website at https://superduperdb.com. This provides a bird's-eye view of the capabilities and features SuperDuperDB has to offer. The notebooks hosted there, can be executed directly in the environment, but can also be cloned in their original form in the open source repo, and executed locally. These notebooks are also described on this documentation website in the use-cases section.

  2. Get setup

    Follow the installation guide and check the minimum-working example to set-up your environment. For more detailed configuration, read the detailed setup section.

  3. Dive into the documentation

    Refer to our comprehensive README.md for a high level of SuperDuperDB. The long-form documentation you are reading now provides deeper insights into features, usage, and best practices.

  4. Explore the community apps examples

    Visit our community apps example repository to explore more examples of how SuperDuperDB can enhance your experience. Learn from real-world use cases and implementations.

  5. Grasp the fundamentals

    Read through the Fundamentals section to gain a solid understanding of SuperDuperDB's architecture and refer to the API References for detailed information on API usage.

  6. Engage with the Community

    If you encounter challenges, join our Slack Channels for assistance. Report bugs and share feature requests by raising an issue. Our community is here to support you.

    You are welcome to join the conversation on our discussions forum and follow our open-source roadmap here.

  7. Contribute and Share

    Contribute to the SuperDuperDB community by sharing your solutions and experiences. Help us grow by promoting SuperDuperDB to your peers and the wider world. Your involvement is valuable to us! Don't forget to give us a star ⭐!

    SuperDuperDB is a community effort and licensed under Apache 2.0. We encourage enthusiastic developers to contribute to the project. Read more here and on GitHub about getting setup and ways you can contribute.

Thank you for choosing SuperDuperDB. We look forward to seeing the amazing solutions you create!