Deploy to Netlify

To begin, create a database.

Ensure that you have an operational PostgreSQL database server capable of accepting remote connections.

If you do not already have a database, consider selecting one from the recommended list below:

• Neon - Serverless Postgres

  During the deployment step, you will be prompted to provide two environment variables for the database. The first is DATABASE_URL, which is the Connection URL to your database using PgBouncer. The second is DIRECT_DATABASE_URL, which serves as the direct connection URL to the database, used for migrations.

Next, set up authentication.

To simplify this guide, we will use Github ↗ (opens in a new tab) as the authentication provider, allowing you to create an account and log in to the Platform. Additionally, this setup will allow other members of your organization to log in as well.

Create a new OAuth App (opens in a new tab) by filling out the form with the following settings:

"Application name": "Feature Flags by Basestack"
"Homepage URL": "https://your-basestack-instance.com"
"Authorization callback URL": "https://your-basestack-instance.com/api/auth/callback/github"

Once you've successfully created a new OAuth App (opens in a new tab), it will generate two important keys: GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET. Be sure to save these keys for later use during the deployment step, as they will be needed as environment variables.

Finally, proceed with the deployment.

Option 1: Quick Deploy (Skip this if you want to receive updates)

By clicking on the button below, a new repository will be created in your GitHub account from the Basestack Platform (opens in a new tab) repository, and the platform will be deployed for you. This will be an independent copy with no connection to the main project.

(opens in a new tab)

Option 2: Fork the Platform

To receive updates from the main repository, you will need to manually fork (opens in a new tab) the project to your GitHub account and import it manually into your Netlify account dashboard. The rest of the process remains the same in terms of configuration, such as Environment Variables and Project Settings. For more details, refer to the Getting Updates Page.

Import to Netlify

1. Log in to Netlify ↗ (opens in a new tab).
2. Click the Add new site dropdown button, then select Import an existing project from the menu.
3. Click the Deploy with Github button.
4. Connect your GitHub account and choose the forked platform repository.
5. Follow the on-screen instructions to set up the necessary Environment Variables and click "Deploy"

"Base directory": "/"
"Site to deploy": "apps/feature-flags"
"Build command": "yarn deploy:feature-flags"
"Publish directory": "apps/feature-flags/.next"

6. Your deploy will be automatically built. Each git push will trigger a new deployment.

Environment Variables

To ensure a successful deployment on Netlify, the platform requires a minimum set of environment variables. Below is the list of environment variables that you must fill in. For the complete list of Environment Variables, please refer to the Configuration Page.