logo

SINGULARITY

DOCS

    Changelog
    6.0.0
  • Getting Started
    • Introduction
    Git Repository
  • Development Guide
    • Installation
    Development Server
    Production Build
    Deployment
    Directory Structure
      API Integration
      API Configuration
      Mock API Documentation
    Code Splitting
    Localization (Multi-Language)
    Updating Guide
    IDE Configuration
  • Configuration
    • Default Settings
    Routing
    Navigation
  • User Interface
    • Theme Schemes
    Theme Layouts
    • Page Layouts
      • Overview
      • CardLayout
          • Full Width
          Full Width Overview
          Full Width Normal Scroll
          Full Width Page Scroll
          Full Width Content Scroll
      Empty Page
    TailwindCSS
    Typography
    Changing Default Font
    RTL Support
  • Authentication & Authorization
    • Authentication
    Authorization
  • Components
PurchaseReturn to the Dashboard

Installation

Prerequisites

This section outlines the essential tools required for using Singularity React.

Node.js

To set up and work with Singularity React, you must have Node.js installed on your system. This documentation won’t delve deeply into Node.js, as it’s beyond its scope. Note that Node.js is only necessary for the development process, not for using the application.

Installation
A. Installing Prerequisites
Download and install at least the LTS or the most recent version of Node.js from its official website.
B. Installing Singularity React
Before starting the installation, create a directory to extract the contents of the downloaded .zip file.
B.1. Choose which version you want to install
Upon extracting the .zip file from Themeforest, you’ll find four additional .zip files among other contents. You can select either the React (Vite) or Next.js version, each available in demo or skeleton variants.
  • Singularity React ViteJs Demo Project Singularity-React-vx.x.x-vitejs-demo.zip
  • Singularity React NextJs Demo Project Singularity-React-vx.x.x-nextjs-demo.zip
This .zip contains the Demo version, which includes all applications, pages, and UI sections from the Demo application. It’s intended solely for reference and should only be used to extract code or modules.
AVOID using the Demo version as the foundation for your app, as it includes excessive components that can overburden your project and hinder the development experience.
  • Singularity React ViteJs Skeleton Project Singularity-React-vx.x.x-vitejs-skeleton.zip
  • Singularity React NextJs Skeleton Project Singularity-React-vx.x.x-nextjs-skeleton.zip
    • This .zip contains the Skeleton version, which provides all core components and functionality of Singularity without the Demo applications, pages, or UI sections. USE the Skeleton version as the base for building your application.
    B.2. Unzip
    Once you’ve selected your preferred version, extract its .zip file into your workspace directory.
    C. Run the installation command
    Open a terminal or console and navigate to your workspace directory, ensuring you’re in the same folder as the package.json file to execute the commands.
    To finalize the installation, run the following command:
    npm install
    This command will take a few moments to install all necessary libraries into the node_modules directory, enabling you to begin development.