Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ekwuno
Ekwuno committed Jan 21, 2025
1 parent 163f507 commit 734ad84
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 23 deletions.
7 changes: 3 additions & 4 deletions src/content/doc-surrealdb/introduction/start.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
sidebar_label: Getting started
title: Getting started with SurrealDB
description: In this guide, we will walk you through installing SurrealDB on your machine, defining your schema, and writing some queries with SurrealQL.
description: In this guide, you will learn about the various ways you can start using SurrealDB, whether you are using SurrealDB in-memory or on-disk via an SDK, CLI, or Surrealist.

---

Expand All @@ -12,12 +12,11 @@ import SurrealistMini from "@components/SurrealistMini.astro";

# Getting started

In this guide, we will walk you through installing SurrealDB on your machine, defining your schema, and writing some queries with SurrealQL.
Since SurrealDB is a multi-model database, you can start using it in a variety of ways. You can use SurrealDB in-memory, on-disk, or via an SDK.


> [!NOTE: BEFORE YOU START ]
> Make sure you’ve [installed SurrealDB](/docs/surrealdb/installation) — it should only take a second!
> Make sure you’ve [installed SurrealDB](/docs/surrealdb/installation) on your machine, this will allow you to start the database and run queries. It should only take a second!
## Start the database

Expand Down
61 changes: 42 additions & 19 deletions src/pages/index.astro
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import IconLink from '@src/components/boxes/IconLink.astro';
<p class="md:w-2/3 lg:w-1/2 text-text/[60%]">
SurrealDB is a native, open-source, and distributed database that is designed to make building and scaling realtime apps dramatically quicker and easier.
</p>
<a href="/docs/surrealdb/introduction/start" class=" border border-border/40 flex-1 inline-flex items-center justify-center px-6 py-3 text-base font-medium bg-[#ff00A0] hover:bg-[#ff00A0]/90 rounded-lg transition-colors">
<a href="/docs/surrealdb/introduction/start" class=" border border-border/40 flex-1 inline-flex items-center justify-center px-6 py-3 text-base font-medium bg-[#ff00A0] hover:bg-[#ff00A0]/90 hover:text-white rounded-lg transition-colors">
Quick Start <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="3" stroke="currentColor" class="w-4 h-4 ml-2">
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 4.5L21 12m0 0l-7.5 7.5M21 12H3" />
</svg>
Expand Down Expand Up @@ -143,7 +143,7 @@ import IconLink from '@src/components/boxes/IconLink.astro';
</h1>
<Boxes wider class="pt-2">
<IconBox
title="Surreal Cloud (Beta)"
title="Surreal Cloud"
description="Manage your SurrealDB database in the cloud with Surreal Cloud."
href="/docs/cloud"
icon={{ light: LightCloud, dark: DarkCloud }}
Expand Down Expand Up @@ -179,37 +179,55 @@ import IconLink from '@src/components/boxes/IconLink.astro';
<h1 class="text-4xl">
Multi-model
</h1>
<Boxes class="pt-2">
<Boxes class="pt-2">
<IconBox
title="Relational"
description="Relational database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealdb/reference-guide/relational"
icon={{ light: LightCloud, dark: DarkCloud }}
/>
<IconBox
title="Document"
description="Document database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealdb/cli/start#surrealkv-beta"
icon={{ light: LightSurrealQL, dark: DarkSurrealQL }}
/>
<IconBox
title="Graph"
description="Graph database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/cloud"
href="/docs/surrealdb/reference-guide/graph_relations"
icon={{ light: LightCloud, dark: DarkCloud }}
/>
<IconBox
title="Vector"
description="Vector database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealdb"
href="/docs/surrealdb/reference-guide/vector-search"
icon={{ light: LightSurrealDB, dark: DarkSurrealDB }}
/>
<IconBox
title="Full-Text Search"
description="Full-Text Search database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealist"
href="/docs/surrealdb/reference-guide/full-text-search"
icon={{ light: LightSurrealist, dark: DarkSurrealist }}
/>
<IconBox
title="Time Series"
description="Time Series database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealml"
href="/docs/surrealdb/reference-guide/time-series"
icon={{ light: LightSurrealML, dark: DarkSurrealML }}
/>
<IconBox
title="Key-Value"
description="Key-Value database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealql"
href="/docs/surrealdb/cli/start#surrealkv-beta"
icon={{ light: LightSurrealQL, dark: DarkSurrealQL }}
/>
<IconBox
title="Geospatial"
description="Geospatial database that is designed to make building and scaling realtime apps dramatically quicker and easier."
href="/docs/surrealdb/reference-guide/geospatial"
icon={{ light: LightSurrealQL, dark: DarkSurrealQL }}
/>
</Boxes>
</div>
<div class="space-y-4">
Expand Down Expand Up @@ -275,70 +293,70 @@ import IconLink from '@src/components/boxes/IconLink.astro';
<IconBox
title="Rust"
status="available"
description="A native async-friendly SDK for Rust with bi-directional, binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/rust"
icon={{ light: LightRust, dark: DarkRust }}
/>
<IconBox
title="JavaScript"
status="available"
description="A native SDK for JavaScript with bi-directional, binary communication over WebSockets or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/javascript"
icon={{ light: LightJavascript, dark: DarkJavascript }}
/>
<IconBox
title="TypeScript"
status="available"
description="Full support for TypeScript definitions from within the JavaScript SDK, for working with strongly-typed data with both locally embedded and remote databases."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/javascript"
icon={{ light: LightTypescript, dark: DarkTypescript }}
/>
<IconBox
title="Node.js"
status="available"
description="A native Node.js engine for use with the JavaScript SDK in server-side environments, enabling in-memory or on-disk deployments using SurrealKV."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/javascript/engines/node"
icon={{ light: LightNodejs, dark: DarkNodejs }}
/>
<IconBox
title="WebAssembly"
status="available"
description="A native WebAssembly engine for use with the JavaScript SDK for web browsers, enabling in-memory or persisted deployments using IndexedDB."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/javascript/engines/wasm"
icon={{ light: LightWasm, dark: DarkWasm }}
/>
<IconBox
title="Java"
status="available"
description="An SDK for Java with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/java"
icon={{ light: LightJava, dark: DarkJava }}
/>
<IconBox
title="Golang"
status="available"
description="An SDK for Golang with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/golang"
icon={{ light: LightGolang, dark: DarkGolang }}
/>
<IconBox
title="Python"
status="coming soon"
description="An SDK for sync or async Python, with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV."
status="available"
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/python"
icon={{ light: LightPython, dark: DarkPython }}
/>
<IconBox
title=".NET"
status="available"
description="An SDK for .NET with binary communication over WebSockets or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV."
description="Connect to SurrealDB over WebSocket or HTTP. Includes support for SurrealDB embedded in-memory and on-disk."
href="/docs/sdk/dotnet"
icon={{ light: LightDotnet, dark: DarkDotnet }}
/>
<IconBox
title="PHP"
status="available"
description="A native SDK for PHP with bi-directional, binary communication over WebSockets or HTTP."
description="Connect to SurrealDB over WebSocket or HTTP."
href="/docs/sdk/php"
icon={{ light: LightPhp, dark: DarkPhp }}
/>
Expand Down Expand Up @@ -374,6 +392,11 @@ import IconLink from '@src/components/boxes/IconLink.astro';
href="/docs/tutorials/working-with-surrealdb-over-http-via-postman"
/>
</Boxes>
<div class="flex justify-end">
<a href="/docs/tutorials" class="text-surreal-pink hover:text-surreal-pink/80 transition-colors duration-200">
Check out other tutorials →
</a>
</div>
</div>
</div>
</div>
Expand Down

0 comments on commit 734ad84

Please sign in to comment.