We store the global configuration of a MakerKit application in /configuration.ts.
Within any application file, we can use the path ~/configuration to
import it from any other file.
You do not need any changes to start developing your application. Feel free to complete the configuration once you want to deploy the app for the first time.
The configuration has the following structure:
export default {
site: {
name: '',
description: '',
themeColor: '#ffffff',
themeColorDark: '#0a0a0a',
siteUrl: process.env.NEXT_PUBLIC_SITE_URL,
siteName: '',
twitterHandle: '',
githubHandle: '',
language: 'en',
convertKitFormId: '',
locale: process.env.NEXT_PUBLIC_DEFAULT_LOCALE,
},
paths: {
signIn: '/auth/sign-in',
signUp: '/auth/sign-up',
emailLinkSignIn: '/auth/link',
onboarding: `/onboarding`,
appHome: '/tasks',
settings: {
profile: '/settings/profile',
authentication: '/settings/profile/authentication',
email: '/settings/profile/email',
password: '/settings/profile/password',
},
api: {
checkout: `/api/stripe/checkout`,
billingPortal: `/api/stripe/portal`,
organizations: {
create: `/api/organizations`,
current: `/api/organizations/[organization]/current`,
transferOwnership: `/api/organizations/owner`,
members: `/api/organizations/members`,
member: `/api/organizations/members/[member]`,
},
},
},
auth: {
requireEmailConfirmation:
process.env.NEXT_PUBLIC_REQUIRE_EMAIL_CONFIRMATION === 'true',
// NB: Enable the providers below in the Supabase Console
// in your production project
providers: {
emailPassword: true,
phoneNumber: false,
emailLink: false,
oAuth: ['google'],
},
},
email: {
host: '',
port: 0,
user: '',
password: '',
},
emailEtherealTestAccount: {
email: process.env.ETHEREAL_EMAIL,
password: process.env.ETHEREAL_PASSWORD,
},
environment: process.env.NEXT_PUBLIC_ENVIRONMENT,
production: process.env.NODE_ENV === 'production',
enableThemeSwitcher: true,
stripe: {
products: [
{
name: 'Basic',
description: 'Describe your basic plan',
plans: [
{
price: '$249/year',
stripePriceId: '<STRIPE_PRICE_ID>',
}
],
},
{
name: 'Pro',
description: 'Describe your pro plan',
plans: [
{
price: '$249/year',
stripePriceId: '<STRIPE_PRICE_ID>',
}
],
},
],
},
};These values are used throughout the application instead of being hardcoded into the codebase.
This file will not be committed (at least not the "secret" variable). So instead, you should define those variables within your favorite CI/CD.
Environment Variables
Makerkit provides templates for configuring your environment variables correctly and the minimum environment variables to run your local environment.
To push your project to production, you must fill these variables by creating your Supabase project and adding the required values.
Development Environment Variables
The development environment variables set your application up for the Supabase environment:
DEFAULT_LOCALE=en
SITE_URL=http://localhost:3000
# SUPABASE
NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
NEXT_PUBLIC_SUPABASE_ANON_KEY=
SUPABASE_SERVICE_ROLE_KEY=
# STRIPE
STRIPE_WEBHOOK_SECRET=
STRIPE_SECRET_KEY=
# TESTING EMAILS. MAKE AN ACCOUNT ON ETHEREAL AND ADD THE CREDENTIALS BELOW
ETHEREAL_EMAIL=
ETHEREAL_PASSWORD=
# SERCET KEY TO SIGN SECRETS. REPLACE THE BELOW WITH A RANDOM AND COMPLEX STRING. KEEPT IT SAFE.
SECRET_KEY=