🚀Get Started

Be ready to ship directories fast.

Hey! Welcome to DirectoryFast 👋

You'll find here the basics to make your app run in no time.

Follow this guide and then jump to Tutorials Section to launch your directory before everyone else! Let's go 💪

Get the code locally

Once you get access to the GitHub repository 👇

1. Run the following commands in your terminal:

Terminal

git clone [e-mail]:DirectoryFast/directoryfast.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
npm install --legacy-peer-deps
git remote remove origin

DirectoryFast requires Node v18.19.0 to work properly.

1. Fill the environnement file

First create the .env file by copying .env.example

Terminal

cp .env.example .env

Then add your data. NEXTAUTH_SECRET can be anything you want.

.env.local

# App
NEXT_PUBLIC_APP_URL="http://localhost:3000"
NEXT_PUBLIC_API_URL="http://localhost:3000/api"
ADMIN_EMAIL=""

# Database URL
# Pooling connection (postgresql://username:password@server:6543/postgres?pgbouncer=true&connection_limit=1)
POSTGRES_URL=
# Non-pooling connection (postgresql://username:password@server:5432/postgres)
POSTGRES_URL_NON_POOLING=

# Next Auth (any string)
NEXTAUTH_SECRET=

# Google Auth
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# Posthog
NEXT_PUBLIC_POSTHOG_KEY=
NEXT_PUBLIC_POSTHOG_HOST="https://app.posthog.com"

# LemonSqueezy
LEMONSQUEEZY_API_KEY=
LEMONSQUEEZY_WEBHOOK_SECRET=
NEXT_PUBLIC_LEMONSQUEEZY_FEATURED_LINK_KEY=

# Loops
LOOPS_API_KEY=
LOOPS_TRANSACTION_ID=

Data from Google Auth OR Loops is required to use the admin function.

1. Everything is set!

Now let's bring this repertoire to life 🚀