Deploying your application
Starter Kit uses Vercel as our deployment platform. Vercel provides hosting for web applications, and offers a range of tools to aid with maintaining your product, including integrations with GitHub.
Setting up Vercel for your product can be done via the deploy button below.
If you are not a public officer with access to Postman.gov.sg, use the "Without Postman API key" button.
With Postman API key:
Without Postman API key:
Step 1: Creating your repository
Vercel will prompt you for a name to create a new GitHub repository. This will create a copy of the Starter Kit code base in your chosen location.
Once you have chosen a name, click Create.
Step 1.1: Creating your team (optional)
Vercel will prompt you to create a team if you are creating the new GitHub repository within an organization.
Step 2: Configuring your project
Once your repository has been created, you will need to provide the required set of environment variables.
The environment variables required are:
| Name | What It Is | Example |
|---|---|---|
SESSION_SECRET | A sequence of random characters used to protect session identifiers, generated by running npx uuid from your terminal. This variable must be at least 32 characters long to pass validation | 66a21b98-fb17-4259-ac4f-e94d303ac894 |
POSTMAN_API_KEY | An API key to send email via Postman | asdfn_v1_6DBRljleevjsd9DHPThsKDVDSenssCwW9zfA8W2ddf/T |
Step 3: Creating your project
Click on Deploy and your copy of Starter Kit will start to deploy.
This deployment will fail because we have not attached the database.
Step 4: Integrating Neon with your project
Navigate to your project and click on settings. In the "Integrations" tab, click on "Browse Marketplace".
Search for "Neon" and select "Neon Postgres".
On the next page, click on "Add Integration".
Select your account (or the newly created team) to add the integration to.
You may choose to enable the integration for all your projects or select a specific project.
After being redirected to Neon, select your project to configure.
If you are not redirected to Neon, visit https://vercel.com/integrations/neon/new.
In the next step, select the Neon database cluster created previously.
Confirm the connection by clicking on the "Connect" button.
To confirm that the integration has been successfully added, check the environment variables under "Settings" within your Vercel project.
You should see the following environment variables: PGHOST, PGDATABASE, PGUSER, PGPASSWORD, and DATABASE_URL.
Step 5: Deploying your project
Now that you've successfully integrated Neon to your Vercel project, trigger a redeployment of your build.