Documentation for Next.js version of Rizz

Structure

When you extract the zip file you received after purchasing, you will find the following files and folders: 


├── src
│   ├── app
│   │   └── (admin pages)
│   │   └── (other pages)
│   │   └── api
│   ├── assets
│   │   ├── data
│   │   ├── fonts
│   │   ├── images
│   │   └── scss
│   ├── components
│   ├── context
│   ├── helpers
│   ├── hooks
│   ├── types
│   └── utils
├── bun.lockb
├── next.config.mjs
├── package-lock.json
├── package.json
├── tsconfig.json
└── yarn.lock
Prerequisites

Please follow below steps to install and setup all prerequisites:

  • Node.js

    In order to use build tools you will need to download and install Node.js. If you do not have Node.js installed already, you can get it by downloading the package installer from the official website. Please download the stable version of Node.js (LTS).

    Download Node.js
Installation

To setup, follow the below mentioned steps:

You can run the following commands to run project locally or build for production use:

You can run this app following package manager: Bun, Yarn or NPM

Note: Run development server once before creating production build to create next-env.d.ts

1. Bun

If you don't have bun installed on your PC, use the npm i -g bun or sudo npm i -g bun to install

Command Description
bun i
 This would install all required dependencies in node_modules folder.
bun dev Runs the project locally, starts the development server.
bun run build It bundles with production mode. Your app is now ready to be deployed.
2. Yarn

If you don't have yarn installed on your PC, use the next command npm i -g yarn or sudo npm i -g yarn

Command Description
yarn
 This would install all required dependencies in node_modules folder.
yarn dev Runs the project locally, starts the development server.
yarn build It bundles with production mode. Your app is now ready to be deployed.
3. NPM

npm comes preinstalled when you install Nodejs

Command Description
npm i or npm i --force
 This would install all required dependencies in node_modules folder.
npm run dev Runs the project locally, starts the development server.
npm run build It bundles with production mode. Your app is now ready to be deployed.