Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basementdevs/scylla-studio
Scylla Studio – ⚡ A modern and intuitive front-end for ScyllaDB 🐙, enabling visualization 👀, creation ✏️, and management ⚙️ of keyspaces and tables, with integrated metrics 📊 in a single tool.
https://github.com/basementdevs/scylla-studio
scylladb
Last synced: about 2 months ago
JSON representation
Scylla Studio – ⚡ A modern and intuitive front-end for ScyllaDB 🐙, enabling visualization 👀, creation ✏️, and management ⚙️ of keyspaces and tables, with integrated metrics 📊 in a single tool.
- Host: GitHub
- URL: https://github.com/basementdevs/scylla-studio
- Owner: basementdevs
- Created: 2024-09-10T16:26:06.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T21:47:31.000Z (5 months ago)
- Last Synced: 2024-09-11T20:26:57.700Z (5 months ago)
- Topics: scylladb
- Language: TypeScript
- Homepage: https://scylladb.studio
- Size: 285 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/basementdevs/scylla-studio/actions/workflows/docker-image.yml)
[](https://discord.gg/8Preg7PfTY)
Scylla Studio
**Scylla Studio** is a front-end application designed for the ScyllaDB ecosystem, inspired by tools like Drizzle and Prisma Studio. It provides an intuitive interface for managing your ScyllaDB keyspaces and tables, integrating essential performance metrics, and offering a unified solution to interact with both local and cloud-based ScyllaDB clusters.
## Key Features
- **Visual Management of Keyspaces and Tables:**
Create, edit, and visualize keyspaces and tables directly from the interface.
- **Integrated Metrics Monitoring:**
Leverages ScyllaDB's Prometheus and Grafana integrations to display important metrics within the app.
- **Cluster Connectivity:**
Easily connect to your local cluster using `https://local.scylladb.studio` or manage cloud-based clusters.
- **NextJS 14 Frontend:**
Built using NextJS 14 for optimal performance, scalability, and a seamless developer experience.
- **Third-Party ScyllaDB JavaScript Driver:**
Powered by the [daniel-boll/scylla-javascript-driver](https://github.com/daniel-boll/scylla-javascript-driver), a Rust-wrapped library for high-performance ScyllaDB interactions.
## Technologies Used
- **NextJS 14** - The latest version of NextJS for front-end development.
- **ScyllaDB** - Distributed database system for high-throughput workloads.
- **Prometheus & Grafana** - For monitoring ScyllaDB metrics.
- **Rust & JavaScript Driver** - A community-driven driver for ScyllaDB, wrapped in Rust for performance.
## Getting Started
1. **Clone the Repository:**
```bash
git clone https://github.com/basementdevs/scylla-studio.git
cd scylla-studio
```
2. **Install Dependencies:**
```bash
pnpm i
```
3. **Start Development Server:**
```bash
pnpm dev
```
4. **Create a Docker Network:**
```bash
docker network create ws-scylla
```
5. **Run a ScyllaDB Instance:**
```bash
docker run --name scylla --network ws-scylla -p "9042:9042" -d scylladb/scylla:6.1.2 \
--overprovisioned 1 \
--smp 1
```
6. **Check your ScyllaDB Instance:**
```bash
# Check for UN status
docker exec -it scylla nodetool status
# Check if the Shell works
docker exec -it scylla cqlsh
```
7. **Access the Studio:**
Once the server is up, visit [https://localhost:3000](https://localhost:3000) to start interacting with your ScyllaDB clusters.
## Running Scylla Studio via Docker
You can run Scylla Studio directly through Docker without setting up the entire environment. To do this, run the following one-liner:
```bash
docker run --rm --name scylla-studio --network="host" ghcr.io/basementdevs/scylla-studio:latest
```
### Persistent Volumes
If you'd like to keep the session data and logs between runs, you can use Docker volumes:
```bash
docker run --rm --name scylla-studio --network="host" \
-v scylla-studio-data:/usr/app/data \
ghcr.io/basementdevs/scylla-studio:latest
```
This will create a persistent volume named `scylla-studio-data` for the application's data.
To remove the volume later:
```bash
docker volume rm scylla-studio-data
```
## Roadmap
- **Support for Indexes and Materialized Views:**
Future versions will include advanced schema management for indexes and materialized views.
- **User Authentication & Roles:**
Role-based access control for managing permissions across team members.
- **Enhanced Metrics Dashboard:**
Deeper integration with Grafana for real-time monitoring and custom alerts.
## Contributing
Scylla Studio is an open-source project in collaboration with the **Basement Devs**, a community focused on helping people access better opportunities in Europe and the USA.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.