Installation

React/Remix

If you're using the Remix version of the template, you'll need to have Node.js and either NPM or YARN installed on your system.

Installing React Prerequisites

Node.js and NPM: You can download Node.js from https://nodejs.org, and NPM will be installed along with it.

For YARN, refer to the installation instructions here.

For Bun, you can find the installation instructions here.

Installing Packages

Before getting started, make sure to install the required dependencies. You can do this by running one of the following commands from the root directory of your project:

#bun
bun install

#npm
npm install

#yarn
yarn install

Running Remix Init

If you did not scaffold your project using the create-remix cli tool you can run bun remix init to initialize your project and choose between having the full demo dashboard or just having the barebones dashboard.

Running Remix Project

This template is built on Remix. For detailed instructions on how to use Remix, you can refer to this link.

To launch a development server, run one of the following commands:

#npm
npm run dev

#yarn
yarn dev

#bun
bun dev

After launching the server, navigate to http://localhost:3000/ in your browser. The app will automatically reload if you make any changes to the source files.

For a production-ready build, first, run yarn build to build the project. Then, start the server using yarn start.