Skip to content

Getting Started

This guide will help you set up the SREDSimplify frontend locally for development.

Prerequisites

  • Node.js: v20 or higher
  • npm: v10 or higher
  • A running instance of the Backend service.

Installation

  1. Navigate to the frontend directory:
    bash
    cd frontend
  2. Install dependencies:
    bash
    npm install

Development

To start the development server:

bash
npm run dev

The application will be available at http://localhost:3000.

Available Scripts

CommandDescription
npm run devStarts the Next.js development server.
npm run buildBuilds the application for production.
npm run startStarts the production server.
npm run lintRuns ESLint checks.
npm run typecheckRuns TypeScript compiler checks without emitting files.
npm run test:unitRuns unit tests using Vitest.
cd docs && npm run docs:devStarts the VitePress documentation server locally.