You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Install dependencies
pnpm i
# Configure environment variables# There is an `.env.example` in the root directory you can use for reference
cp .env.example .env.local
# Start docker containers# use `docker compose down` to stop the containers afterwards
docker compose up -d
# Push the Prisma schema to the database
pnpm db:push
Optionally set POSTMAN_API_KEY to send login OTP emails via Postman.
If not set, OTP emails will be logged to the console instead.
Retrieving client-side environment variables in code
⚠️ When adding client-only environment variables in NextJS, you must prefix the variable with NEXT_PUBLIC_ to ensure that the variable is exposed to the browser. For example, if you want to add a variable called MY_ENV_VAR, you should add it to your .env file as NEXT_PUBLIC_MY_ENV_VAR.
You will also need to update the various environment files (like apps/web/src/env.ts or packages/db/src/env.ts) to explicitly reference the variable so NextJS will correctly bundle the environment variable into the client-side bundle.
2. Adding a new package
To add a new package, simply run pnpm turbo gen init in the monorepo root. This will prompt you for a package name as well as if you want to install any dependencies to the new package (of course you can also do this yourself later).
The generator sets up the package.json, tsconfig.json and a index.ts, as well as configures all the necessary configurations for tooling around your package such as formatting, linting and typechecking. When the package is created, you're ready to go build out the package.
Deployment
Follow these instructions if you are familiar with building applications,
and/or are in a hurry to prepare an environment to work on your product.
If you are exploring what else you can do with Starter Kit,
a more comprehensive set of documentation, including guides
and tutorials, can be found here.
The Vercel deployment outlined below is optimised for quick prototyping and development. It is not recommended for serious production use.
For serious production use cases, consider directly deploying Starter Kit to AWS. We provide a command line interface (CLI) tool (for internal use only) that can help you deploy Starter Kit to a standardised AWS infrastructure.
Nonetheless, on low-risk production use cases, Vercel can still be used as a production deployment. We have a document on when one might want to migrate to AWS here.
Deploy to Vercel
Let's deploy the Next.js application to Vercel. If you've never deployed a Turborepo app there, don't worry, the steps are quite straightforward. You can also read the official Turborepo guide on deploying to Vercel.
Create a new project on Vercel, select the apps/web folder as the root directory. Vercel's zero-config system should handle all configurations for you.
Add the prerequisite environment variables outlined in the Prerequisites section.
Done! Your app should successfully deploy.
Prerequisites
The deployment needs a few environment variables to be set for it to function. They are:
Name
What It Is
Example
DATABASE_URL
The connection string for your database. This should have been obtained from Neon
Next steps: Take a moment to review the security alert
above. Review the linked package source code to understand the potential
risk. Ensure the package is not malicious before proceeding. If you're
unsure how to proceed, reach out to your security team or ask the Socket
team for help at [email protected].
Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.
Mark the package as acceptable risk. To ignore this alert only
in this pull request, reply with the comment
@SocketSecurity ignore npm/[email protected]. You can
also ignore all packages with @SocketSecurity ignore-all.
To ignore an alert for all future pull requests, use Socket's Dashboard to
change the triage state of this alert.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
TODOs:
Starter Kit
A technical kit to quickly build new products from
Open Government Products, Singapore.
Features
Project structure
Working on your product
You may work on the codebase with:
Using GitHub Codespaces
Follow the official GitHub guide
for developing with a codespace.
Using your local developer environment
In summary:
Running the app locally
1. Setup dependencies
Optionally set
POSTMAN_API_KEYto send login OTP emails via Postman.If not set, OTP emails will be logged to the console instead.
Retrieving client-side environment variables in code
NEXT_PUBLIC_to ensure that the variable is exposed to the browser. For example, if you want to add a variable calledMY_ENV_VAR, you should add it to your.envfile asNEXT_PUBLIC_MY_ENV_VAR.You will also need to update the various environment files (like apps/web/src/env.ts or packages/db/src/env.ts) to explicitly reference the variable so NextJS will correctly bundle the environment variable into the client-side bundle.
2. Adding a new package
To add a new package, simply run
pnpm turbo gen initin the monorepo root. This will prompt you for a package name as well as if you want to install any dependencies to the new package (of course you can also do this yourself later).The generator sets up the
package.json,tsconfig.jsonand aindex.ts, as well as configures all the necessary configurations for tooling around your package such as formatting, linting and typechecking. When the package is created, you're ready to go build out the package.Deployment
Follow these instructions if you are familiar with building applications,
and/or are in a hurry to prepare an environment to work on your product.
If you are new, see our Getting Started guide.
If you are exploring what else you can do with Starter Kit,
a more comprehensive set of documentation, including guides
and tutorials, can be found here.
Deploy to Vercel
Let's deploy the Next.js application to Vercel. If you've never deployed a Turborepo app there, don't worry, the steps are quite straightforward. You can also read the official Turborepo guide on deploying to Vercel.
Create a new project on Vercel, select the
apps/webfolder as the root directory. Vercel's zero-config system should handle all configurations for you.Add the prerequisite environment variables outlined in the Prerequisites section.
Done! Your app should successfully deploy.
Prerequisites
The deployment needs a few environment variables to be set for it to function. They are:
DATABASE_URLPOSTMAN_API_KEYSESSION_SECRETnpx uuidfrom your terminal