Next-start
installation

development

Learn how to set up your development environment for a smoother experience.

To get started, insure you have the following installed on your local machine:

Project development

Install Dependecies

pnpm install

Why pnpm?

pnpm is used because it's faster and more efficient than npm or yarn. It saves disk space and boosts installation speed by using a content-addressable file system to store all packages in a single location on your disk. When you install a package, pnpm creates hard links to the packages in this central store, instead of copying them.

Setup environment variables

Setup .env file

You can duplicate the .env.example and .env.local.example files and rename it to .env and .env.local. Then, set the variables according to your needs.

Start database

docker compose up -d

Why docker?

We use docker to run a local database. This is optional, but it's recommended if you want to develop locally. If you want to connect to a remote database, you can skip this step and configure the connection details in the .env file.

Start development server

pnpm run dev

Development server

This command starts the development server. You can access the application in your browser at http://localhost:3000.

Deploy to production

pnpm run build && pnpm run start

Production deployment

This command builds the application for production and starts the production server.

How is this guide?

On this page