Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup old references #3755

Merged
merged 1 commit into from
Jan 2, 2024
Merged

cleanup old references #3755

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This is a full list of development dependencies:
- [Docker](https://www.docker.com)
- [Node.js 18](https://nodejs.org/en/) (we recommend installing it with [nvm](https://github.com/nvm-sh/nvm))
- [Go 1.21](https://go.dev) (on macOS, install with `brew install go`)
- [GraalVM](https://www.graalvm.org) and [Maven](https://maven.apache.org) for Java (we recommend installing both through [sdkman](https://sdkman.io))
- [Buf](https://buf.build) (Protocol Buffers) (on macOS, install with `brew install bufbuild/buf/buf`)

Run `sh scripts/devtool.sh` from project root to run all services locally. Refer `scripts/devtool/README.md` for more details.
Expand Down Expand Up @@ -53,7 +52,6 @@ Here's a high-level overview of the technologies we use for different parts of t

- Typescript and SvelteKit for all frontend code
- Go for the CLI and runtime (backend)
- Java and Apache Calcite for the SQL engine, which gets compiled to a native library using GraalVM
- DuckDB for OLAP on small data
- Apache Druid for OLAP on big data
- Postgres for handling metadata in hosted deployments
Expand All @@ -72,13 +70,12 @@ The project uses NPM for Node.js (specifically, NPM [workspaces](https://docs.np

Here's a guide to the top-level structure of the repository:

- `.github` and `.travis.yml` contain CI/CD workflows. We allow both, but the goal is to move fully to Github Actions.
- `.github` contain CI/CD workflows.
- `admin` contains the backend control plane for a multi-user, hosted version of Rill (in progress, not launched yet).
- `cli` contains the CLI and a server for the local frontend (used only in production).
- `docs` contains the user-facing documentation that we deploy to [docs.rilldata.com](https://docs.rilldata.com).
- `proto` contains protocol buffer definitions for all Rill components, which notably includes our API interfaces.
- `runtime` is our data plane, responsible for querying and orchestrating data infra. It currently supports DuckDB and Druid.
- `sql` contains our SQL parser and transpiler. It's based on Apache Calcite.
- `web-admin` contains the frontend control plane for a multi-user, hosted version of Rill (in progress, not launched yet).
- `web-common` contains common functionality shared across the local and cloud frontends.
- `web-local` contains the local Rill Developer application, including the data modeller and current CLI.