This repo is the frontend interface for SandWorm, a multi-chain blockchain data explorer and query IDE. We currently support Sui, Base, Ethereum, and other EVM-compatible networks and actively expanding to additional ecosystems beyond EVM. This repository contains the web-based UI, including the landing page, public gists, and the integrated IDE for querying blockchain data with SandWorm's SQL-like query language (WQL).
- Landing Page – Introduces SandWorm and its capabilities, TOC's, tutorial.
- Public Gists – View and share useful queries with the community.
- IDE – An interactive environment to write, test, and execute WQL queries. (/Workspace)
This repo includes two roadmaps:
- Main App Roadmap: Auth, landing page, navigation, settings, etc.
- Workspace Roadmap: Query editor, tab management, execution engine, etc.
Ensure you have the following installed:
- Node.js (Latest LTS recommended)
- Yarn or npm or pnpm
- Firebase CLI (for local emulation, optional)
Copy the example .env file and configure it with the necessary values:
cp .env.example .env.localClone the repository and install dependencies:
git clone https://github.com/sand-worm-sql/web-app.git
cd webapp
pnpm install # or npm installTo start the development server:
pnpm run dev # or npm run devThis will start the Next.js development server on http://localhost:3000/.
If you want to use the Firebase emulator for local development:
- Install Firebase CLI:
pnpm install -g firebase-tools
- Login to Firebase:
firebase login
- Start the Firebase emulator:
By default, the app is set up to work with a live Firebase instance. Update your
firebase emulators:start
.env.localfile if you want to switch between live and emulator.
If you get could not spawn java version or java path error. You need to install java and set to path for the emulator to run
This repository follows a structured approach with relevant documentation in place:
/public– Static assets./src/components– Reusable React components./src/app– Page routes./docs– Additional documentation./README.md– This document./DEVELOPER_NOTE.md– Developer-specific notes, guidelines, and pending features.- Folder-specific README files – Some folders contain dedicated README files listing pending features or developer notes.
To contribute
- Read our Contributing Guidelines (to be added).
- Check the Developer Notes (
DEVELOPER_NOTE.md) for pending features. - Follow the project structure and coding guidelines.
To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit your changes (
git commit -m "Added new feature"). - Push to the branch (
git push origin feature-branch). - Open a Pull Request.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions, feel free to open an issue or reach out to the team through our official channels.