Skip to content

Latest commit

 

History

History
143 lines (105 loc) · 6.18 KB

README.md

File metadata and controls

143 lines (105 loc) · 6.18 KB
Raw

Valkey Sandbox

Valkey Sandbox is your gateway to effortlessly exploring Valkey's power with various Valkey clients.
No setup, no orchestration—just sit, start, and experience a fully functional app in seconds.
With an easy-to-use IDE, customizable infrastructure, and support for multiple clients like GLIDE across various programming languages, it delivers a practical, hands-on Valkey experience.
All the common use cases, simple or complex, are at your fingertips.
Dive in, choose what to build, and discover how GLIDE simplifies Valkey workflows. Modern, intuitive, and ready to go.

🚀 Features

  • Interactive Code Editor: Syntax-highlighted code editor with real-time validation.
  • Real-time Terminal Output: View output from your code executions instantly.
  • Multiple Execution Modes: Switch between Standalone and Cluster modes effortlessly.
  • Built-in Code Templates: Start quickly with ready example implementations such as:
    • Search Engine
    • Session Cache
    • Recommendation System
    • And more.
  • WebSocket-based Real-time Updates: Experience seamless data updates without page refreshes.
  • Integrated Execution Environments: Run Python and Node.js code directly in the browser, with Java and Go support coming soon.
  • Gamified Watch-in-Action Features:
    • Leaderboard: Dynamic leaderboard showcasing real-time data updates, player rankings, and score changes.
    • Task Manager: Visualize and manage task queues, learn about task scheduling, and observe task execution in real-time.
  • Resources: Access a wealth of valuable materials, including documentation, tutorials, blogs, FAQs, deployment guides, sessions, and more to deepen your understanding of Valkey and Glide.
  • Community: Engage with the Valkey team, Glide team and fellow developers. Join our community channels, participate in discussions, and stay connected through our social media platforms.
  • Challenge Yourself: Enhance your skills with weekly challenges, coding quizzes, and a variety of problems designed to test and improve your proficiency while having fun.

🎮 Gamified Watch-in-Action

Experience Valkey's capabilities through interactive gamified features that not only showcase but actually execute real Glide code, demonstrating Valkey's abilities in an engaging and enjoyable way:

  • Leaderboard: Observe Valkey handling real-time data updates and ranking computations powered by live code execution.
  • Task Manager: Visualize and interact with task scheduling and execution using Valkey's queue management, seeing firsthand how the underlying code operates.

🎯 Challenge Yourself

Enhance your skills with weekly challenges, coding quizzes, and a variety of problems designed to test and improve your proficiency while having fun.

  • Coding Challenges: Solve practical programming problems using Glide with Valkey. Challenges range from easy to hard, and you can write and test your code directly in the browser using Python, JavaScript, or Java.
  • Quizzes: Test your knowledge with multiple-choice questions. Get instant feedback and links to relevant resources.
  • Weekly Special Challenge: Tackle a new, complex challenge every week. Submit your solution in your preferred language and receive feedback at the end of the week, along with the correct answer.

This feature allows you to:

  • Run Tests: Instantly test your code submissions and see the results.
  • Select Programming Language: Choose between Python, JavaScript, and Java for coding challenges.
  • Accumulate Scores:
    • Quizzes: 1 point per correct answer.
    • Easy Coding Challenges: 3 points.
    • Medium Coding Challenges: 5 points.
    • Hard Coding Challenges: 8 points.
    • Weekly Challenges: 30 points.
  • Weekly Streaks: Earn a 10% bonus on weekly challenges for each consecutive week you participate.

With a competitive scoring system and engaging challenges, you can improve your Valkey and Glide skills while having fun.

🛠️ Prerequisites

  • Docker and Docker Compose
  • Node.js (v14 or higher)
  • npm or yarn

🏃‍♂️ Quick Start

  1. Clone the repository:

    git clone https://github.com/avifenesh/valkey-sandbox.git
cd valkey-sandbox

  2. Set up the environment:

    chmod +x setup.sh
./setup.sh --dev  # For development mode
# or
./setup.sh        # For production mode
    • To clean up running processes: 
      ./setup.sh --cleanup

  3. Access the sandbox:

    • Open your browser and navigate to http://localhost:8080.

With just one click, you'll have a fully orchestrated, functioning application ready to use.

💡 Contributing

We welcome contributions! Here are some areas where you can help:

Priority Areas

  1. Test Coverage

    • Implement unit tests for backend services.
    • Add frontend component tests.
    • Create integration tests.
    • Add E2E testing setup.

  2. Documentation

    • API documentation.
    • Usage examples.
    • Tutorial content.

  3. Features

    • Additional code templates.
    • More Valkey-Glide examples.
    • Performance monitoring.
    • Support for multiple Valkey versions.

  4. UI/UX Improvements

    • Theme customization.
    • Mobile responsiveness.
    • Accessibility enhancements.

How to Contribute

  1. Check existing issues or create a new one.
  2. Fork the repository.
  3. Create a feature branch.
  4. Submit a pull request.

See DEVELOPER.md for technical details.

🔗 Related Projects

📚 Documentation

For detailed documentation and contribution guidelines, see DEVELOPER.md.

🤝 Support

For issues and feature requests, please use the GitHub issue tracker.

📜 License

This project is licensed under the Apache License 2.0. For more details, see the LICENSE file.

This project uses Valkey-Glide under the Apache License 2.0.

For all other dependencies, please see their respective license files in the node_modules directory.