52 lines
2.3 KiB
Plaintext
52 lines
2.3 KiB
Plaintext
---
|
|
title: Getting Started | Datasquirel docs
|
|
description: Get up and running with Datasquirel quickly
|
|
page_title: Getting Started
|
|
page_description: Everything you need to start managing your data with Datasquirel.
|
|
---
|
|
|
|
## Welcome to Datasquirel
|
|
|
|
Datasquirel is a cloud-based SQL data management platform built on MariaDB. It gives you a web GUI for managing databases, tables, and entries, a REST API for programmatic access, and a TypeScript npm package that wraps the API with full type safety.
|
|
|
|
## Where to Start
|
|
|
|
If you want to be up and running as quickly as possible, follow the [Quick Start](/docs/quick-start) guide — it walks you through creating an account, adding a database and table, and making your first API call in minutes.
|
|
|
|
<div className="w-full grid grid-cols-1 gap-4 items-stretch">
|
|
<DocsCard
|
|
title="Quick Start"
|
|
description="Create an account, add a database, and fetch your first record."
|
|
href="/docs/quick-start"
|
|
/>
|
|
<DocsCard
|
|
title="GUI Reference"
|
|
description="Learn how to use the Datasquirel web admin panel."
|
|
href="/docs/gui-reference"
|
|
/>
|
|
<DocsCard
|
|
title="API Reference"
|
|
description="REST API documentation and SDK usage."
|
|
href="/docs/api-reference"
|
|
/>
|
|
<DocsCard
|
|
title="Self Hosting"
|
|
description="Deploy Datasquirel on your own infrastructure."
|
|
href="/docs/self-hosting"
|
|
/>
|
|
</div>
|
|
|
|
## Datasquirel or Self Hosted?
|
|
|
|
**Datasquirel.com** — create a free account at [datasquirel.com/signup](/signup) and start managing data immediately. No infrastructure to set up.
|
|
|
|
**Self Hosted** — download the Datasquirel Docker stack and run it on your own server or cloud VM. You own the data and the infrastructure. See the [Self Hosting](/docs/self-hosting) guide to get started.
|
|
|
|
## Core Concepts
|
|
|
|
- **Database** — a named collection of tables. Each user account can have multiple databases.
|
|
- **Table** — a set of rows that share the same column structure (schema).
|
|
- **Field** — a column in a table. Each field has a name, a SQL data type, and optional constraints.
|
|
- **Entry** — a single row in a table.
|
|
- **API Key** — a credential used to authenticate REST API requests. Read-only keys can only fetch data; full-access keys can read, write, update, and delete.
|