FireStudio LogoFireStudio
ProductsAuroraMC

Installation

Set up your development environment and get AuroraMC running locally.

Installation

Follow these steps to get your AuroraMC store running on your local machine.

Prerequisites

Make sure you have the following before starting:

  • Node.js 18 or later — Download here. LTS version is recommended.
  • npm — Comes bundled with Node.js. Run node -v and npm -v to verify both are installed.
  • A Tebex account — Sign up at tebex.io and create a webstore if you haven't already.

Step 1 — Install Dependencies

Open a terminal, navigate to the project folder, and install packages:

cd AuroraMC-main
npm install

This installs React, Vite, Tailwind CSS, Radix UI, Framer Motion, and all other dependencies defined in package.json.

Step 2 — Configure Environment Variables

Create a .env file in the project root (or rename the existing .env file). You only need one variable:

.env
VITE_TEBEX_PUBLIC_TOKEN=your_tebex_public_token_here

Where to Find Your Token

  1. Log in to your Tebex Dashboard
  2. Navigate to Settings → API Keys
  3. Under Headless API, click Enable if it isn't already active
  4. Copy the Public Token and paste it into your .env file

[!IMPORTANT] The public token is the only credential required. AuroraMC uses the Tebex Headless API which operates entirely from the browser — no secret keys are stored in your code.

Step 3 — Start the Development Server

Run the dev server to preview your store locally:

npm run dev

Vite will start and show a local URL in the terminal, typically:

Local: http://localhost:5173/

Open that URL in your browser. Changes you make to the code will hot-reload instantly.

Step 4 — Build for Production

When you're ready to deploy, create a production build:

npm run build

This generates a dist/ folder containing optimized static HTML, CSS, and JavaScript files. See the Deployment Guide for hosting instructions.

Other Commands

CommandDescription
npm run devStart the local development server with hot reload
npm run buildCreate an optimized production build in dist/
npm run previewPreview the production build locally
npm run lintRun ESLint to check for code issues
npm run testRun the test suite with Vitest

Troubleshooting

npm install Fails or Hangs

Delete node_modules and the lock file, then reinstall:

rm -rf node_modules package-lock.json
npm install

On Windows, use rmdir /s /q node_modules or just delete the folder manually.

"Tebex public token is not configured" Error

This means the .env file is missing or VITE_TEBEX_PUBLIC_TOKEN is not set. Double-check that:

  1. The .env file exists in the project root (same level as package.json)
  2. The variable name is spelled exactly as VITE_TEBEX_PUBLIC_TOKEN
  3. You restarted the dev server after editing .env — Vite only reads env files on startup

Store Loads But Products Show Errors

Verify that your Tebex Headless API is enabled and the token is correct. Log in to your Tebex dashboard and check under Settings → API Keys.

Port 5173 Is Already in Use

Another process is using that port. Either stop the other process, or start Vite on a different port:

npm run dev -- --port 3000

On this page

InstallationPrerequisitesStep 1 — Install DependenciesStep 2 — Configure Environment VariablesWhere to Find Your TokenStep 3 — Start the Development ServerStep 4 — Build for ProductionOther CommandsTroubleshootingnpm install Fails or Hangs"Tebex public token is not configured" ErrorStore Loads But Products Show ErrorsPort 5173 Is Already in Use