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.

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

Move Next.js Quickstart into an env-switcher #8350

Merged
merged 4 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions docs/intro/quickstart/connecting/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. edb:env-switcher::

==========
Connecting
==========

.. toctree::
:maxdepth: 3
:hidden:

nextjs
60 changes: 6 additions & 54 deletions docs/intro/quickstart/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _ref_quickstart:

==========
Quickstart
==========
Expand All @@ -8,55 +6,9 @@ Quickstart
:maxdepth: 1
:hidden:

setup
modeling
connecting
working
inheritance


Welcome to the quickstart tutorial! In this tutorial, you will update a simple Next.js application to use |Gel| as your data layer. The application will let users build and manage their own study decks, with each flashcard featuring customizable text on both sides - making it perfect for studying, memorization practice, or creating educational games.

Don't worry if you're new to |Gel| - you will be up and running with a working Next.js application and a local |Gel| database in just about **5 minutes**. From there, you will replace the static mock data with a |Gel| powered data layer in roughly 30-45 minutes.

By the end of this tutorial, you will be comfortable with:

* Creating and updating a database schema
* Running migrations to evolve your data
* Writing EdgeQL queries in text and via a TypeScript query builder
* Building an app backed by |Gel|

Features of the flashcards app
------------------------------

* Create, edit, and delete decks
* Add/remove cards with front/back content
* Simple Next.js + Tailwind UI
* Clean, type-safe schema with |Gel|

Requirements
------------

Before you start, you need:

* Basic familiarity with TypeScript, Next.js, and React
* Node.js 20+ on a Unix-like OS (Linux, macOS, or WSL)
* A code editor you love

Why |Gel| for Next.js?
----------------------

* **Type Safety**: Catch data errors before runtime
* **Rich Modeling**: Use object types and links to model relations
* **Modern Tooling**: TypeScript-friendly schemas and migrations
* **Performance**: Efficient queries for complex data
* **Developer Experience**: An intuitive query language (EdgeQL)

Need Help?
----------

If you run into issues while following this tutorial:

* Check the `Gel documentation <https://docs.geldata.com>`_
* Visit our `community Discord <https://discord.gg/gel>`_
* File an issue on `GitHub <https://github.com/geldata/gel>`_
overview/index
setup/index
modeling/index
connecting/index
working/index
inheritance/index
12 changes: 12 additions & 0 deletions docs/intro/quickstart/inheritance/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. edb:env-switcher::

===========
Inheritance
===========

.. toctree::
:maxdepth: 3
:hidden:

nextjs

13 changes: 13 additions & 0 deletions docs/intro/quickstart/modeling/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. edb:env-switcher::

========
Modeling
========

.. toctree::
:maxdepth: 3
:hidden:

nextjs


11 changes: 11 additions & 0 deletions docs/intro/quickstart/overview/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. edb:env-switcher::

========
Overview
========

.. toctree::
:maxdepth: 3
:hidden:

nextjs
51 changes: 51 additions & 0 deletions docs/intro/quickstart/overview/nextjs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
.. _ref_quickstart:

==========
Quickstart
==========

Welcome to the quickstart tutorial! In this tutorial, you will update a simple Next.js application to use |Gel| as your data layer. The application will let users build and manage their own study decks, with each flashcard featuring customizable text on both sides - making it perfect for studying, memorization practice, or creating educational games.

Don't worry if you're new to |Gel| - you will be up and running with a working Next.js application and a local |Gel| database in just about **5 minutes**. From there, you will replace the static mock data with a |Gel| powered data layer in roughly 30-45 minutes.

By the end of this tutorial, you will be comfortable with:

* Creating and updating a database schema
* Running migrations to evolve your data
* Writing EdgeQL queries in text and via a TypeScript query builder
* Building an app backed by |Gel|

Features of the flashcards app
------------------------------

* Create, edit, and delete decks
* Add/remove cards with front/back content
* Simple Next.js + Tailwind UI
* Clean, type-safe schema with |Gel|

Requirements
------------

Before you start, you need:

* Basic familiarity with TypeScript, Next.js, and React
* Node.js 20+ on a Unix-like OS (Linux, macOS, or WSL)
* A code editor you love

Why |Gel| for Next.js?
----------------------

* **Type Safety**: Catch data errors before runtime
* **Rich Modeling**: Use object types and links to model relations
* **Modern Tooling**: TypeScript-friendly schemas and migrations
* **Performance**: Efficient queries for complex data
* **Developer Experience**: An intuitive query language (EdgeQL)

Need Help?
----------

If you run into issues while following this tutorial:

* Check the `Gel documentation <https://docs.geldata.com>`_
* Visit our `community Discord <https://discord.gg/gel>`_
* File an issue on `GitHub <https://github.com/geldata/gel>`_
11 changes: 11 additions & 0 deletions docs/intro/quickstart/setup/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. edb:env-switcher::

=====
Setup
=====

.. toctree::
:maxdepth: 3
:hidden:

nextjs
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/intro/quickstart/working/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. edb:env-switcher::

=======
Working
=======

.. toctree::
:maxdepth: 3
:hidden:

nextjs



Loading