Platform

Next.js starter template for creating modern apps easier

Used by

Important

Working in progress, breaking changes are expected.

Features

This template includes the following:

Next.js 14
TypeScript
ESLint
Prettier
Chakra UI
Prisma
Next-Auth
Docker Compose with:
- PostgresQL
- Redis
- Mailpit
And plenty of well-crafted components like HeroSection, Features, Pricings, SubscribeForm etc.

Demo

https://platform.sieutoc.website

Gallery

Click me to see more

Getting Started

For Development

We use pnpm package manager. Get it here.
Make sure Docker up and running.
If your Docker account has 2FA enabled, you have to create a Personal Access Token and login before:
- Follow this guide.
- Login with docker login --username <your-username>

Clone the project

You can either use this template by:

Click the "Use this template" button and follow the instruction
Or using the script below:

pnpm dlx tiged websitesieutoc/platform your-project

Optional: Search and replace platform with your project slug.

Optional but highly recommended: Replace all the logo and favicon files in /public and meta data with your project resources.

Install dependencies

cd your-project
pnpm install

Setup environment variables

For the first time, you need some default environment variables:

cp .env.example .env

If you want to use magic link login

Uncomment the SMPT section in .env file. By default we already set Mailpit for you.

The mailbox can be reach at http://localhost:8025

If you want to use GitHub login

Uncomment the GITHUB section in .env file. Follow this documentation to configure the authentication.

Setup PostHog

Register a PostHog account here: https://posthog.com/, or https://posthog.com/eu if you are in EU.
Create a new project, then follow the instructions to get the POSTHOG_KEY

Let's get started!

Then, run the development server:

pnpm dev

Open http://localhost:3000 with your browser and start developing.

Further instructions

The idea of this starter is, you can use it to quickly start developing a product/service but still have lot of controls over how you craft the product.

More detailed documentation will be published soon.

Contributions

If you find this starter template miss something important, feel free to open an issue and we can discuss more about it.

PRs are always welcome. <3

getsieutoc/platform