# Get Started

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](https://docs.directoryfa.st/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:

{% code title="Terminal" overflow="wrap" lineNumbers="true" %}

```bash
git clone git@github.com:DirectoryFast/directoryfast.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
npm install --legacy-peer-deps
git remote remove origin
```

{% endcode %}

{% hint style="info" %}
DirectoryFast requires Node v18.19.0 to work properly.
{% endhint %}

2. Fill the environnement file

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

{% code title="Terminal" %}

```bash
cp .env.example .env
```

{% endcode %}

Then add your data. NEXTAUTH\_SECRET can be anything you want.

{% code title=".env.local" overflow="wrap" lineNumbers="true" %}

```bash
# 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=
```

{% endcode %}

{% hint style="info" %}
Data from Google Auth OR Loops is required to use the admin function.
{% endhint %}

3. Everything is set!<br>

Now let's bring this repertoire to life 🚀


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.directoryfa.st/get-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.