Skip to content

Improve local development docs #201

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.

Sign up for GitHub

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

Merged
steven-tey merged 1 commit into from
Mar 20, 2025
Merged

Improve local development docs #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions local-development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ First, clone the [Dub repo](https://d.to/github) into a public GitHub repository

<Step title="Set up environment variables">

Copy the `.env.example` file from `./apps/web` to `.env`:
Copy the `.env.example` file from `./apps/web` to `.env` by executing the following command from `apps/web`:

```bash Terminal
cp ./apps/web/.env.example .env
Expand Down Expand Up @@ -166,9 +166,9 @@ Next, you'll need to set up the [Tinybird](https://tinybird.co) Clickhouse datab

In your newly-cloned Dub repo, navigate to the `packages/tinybird` directory.

Install the Tinybird CLI with `pip install tinybird-cli` (requires Python >= 3.8).
If you have `brew`, install `pipx` by running `brew install pipx`. If not, you can check [installation guide](https://pipx.pypa.io/stable/installation/) for other options. After that, install the Tinybird CLI with `pipx install tinybird-cli` (requires Python >= 3.8).

Run `tb auth` and paste your `admin` Auth Token.
Run `tb auth --interactive` and paste your `admin` Auth Token.

</Step>

Expand Down Expand Up @@ -417,7 +417,11 @@ To view emails sent from your application during local development, you'll need

</Steps>

## Step 6: Start the development server
## Step 6: Set NextAuth secret

Generate a secret by visiting https://generate-secret.vercel.app/32. Set the value of `NEXTAUTH_SECRET` in `.env` to this value.

## Step 7: Start the development server

Finally, you can start the development server. This will build the packages + start the app servers.

Expand Down