Quick Start

You just scaffolded a new GELLIFY App and are ready to go. Here is the bare minimum to get your app working.

Requirements

Docker or Podman
Node Version Manager (fnm reccomended to switch version automagically)

Getting started

First you have to create a copy of the environment variables.

cp .env.example .env

Then follow the instruction below to fill the .env with the required pieces to get you started.

GELLIFY app will come with a start-localstack.sh bash script that can create a docker container with a database for local development. If you already have a database, feel free to delete this file and put your database credentials in .env.

./start-localstack.sh

The .env file in your project directory already contains a valid DB url for local development via Docker. The first step is to run pnpm db:push to push your schema.

pnpm run db:push

Your app is already configured to talk to Neon and has a local Postgres via Docker for local development, we get you started. No initial setup on your part is needed.

Sooner or later you will have to create a remote instance to deploy to. Here the basic steps:

If you're already signed up or coming to Neon from Azure, you can skip ahead to Step 2.
If you haven't signed up yet, you can sign up for free here: Create a Neon Account↗
Create a Neon project and get the necessary DATABASE_URL

Once everything is completed you can update the .env with Clerk variables to point to your remote DB instance.

DATABASE_URL=***

Authentication

Your app includes Clerk, we get you started. This is one of the simplest providers, but it still requires a bit of initial setup on your part. Of course, if you prefer to use a different auth provider, you can also opt-out of Clerk and use something link NextAuth.js instead.

You will need to:

Sign into Clerk Create a Clerk account↗ or sign into the Clerk Dashboard↗.
Create a Clerk application If you've just created an account for the first time, you'll be taken directly to the interactive authentication setup form. Otherwise, you'll be redirected to the Clerk Dashboard↗. To create a new app, select the Create application card. You'll be redirected to the interactive authentication setup form.
Select identifiers and social providers Once you are in the interactive authentication setup form, you will be asked to build your authentication flow. Here, Clerk provides various options for setting up your sign-up and sign-in flows. You can choose to use email, phone, or username as identifiers, and you can enable social authentication providers. Once the application is created, you can also customize your authentication flow by selecting different authentication strategies, verification methods, and more. Learn more about sign-up and sign-in options.

Once everything is completed update the .env with Clerk variables

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_***
CLERK_SECRET_KEY=sk_test_***

Editor Setup

We recommended using Cursor↗ a fork of VSCode with a deeper integration with different AI models. We also provide a .cursorrules file to give the AI the necessary context on technologies, patterns, conventions... The following extensions are recommended for an optimal developer experience. The links below provide editor specific plugin support.

Next Steps

Have a look around the docs, as well as the docs of the packages that your app includes.

Edit on GitHub