Overview

A fully functional and scalable dashboard starter solution for saas and businesess in general

Quick Start — Self-Hosted Deployment

Production install/update/uninstall is fully scripted. One command, no manual npm install / docker build / nginx config needed.

Windows:

.\scripts\windows\install.ps1

Linux:

./scripts/linux/install.sh

This auto-detects Docker; if Docker isn't usable it falls back to a native Node.js static-serve deployment. Force one explicitly:

.\scripts\windows\install.ps1 -Mode docker
.\scripts\windows\install.ps1 -Mode native

./scripts/linux/install.sh --mode docker
./scripts/linux/install.sh --mode native

Update and uninstall:

.\scripts\windows\update.ps1
.\scripts\windows\uninstall.ps1

./scripts/linux/update.sh
./scripts/linux/uninstall.sh

Architecture

Browser
  |
  v
Nginx container (or native Node static server, see below)
  |  serves the built SPA (dashboard/dist)
  v
https://reqres.in/api   <- called directly from the browser, no backend/proxy

There is no backend, no database, and no other service in this repository — just this static React/Vite SPA. Production always serves the built app (npm run build output) through Nginx (Docker) or a small static file server (native) — never vite dev/vite preview.

• Host port: APP_PORT in the root .env (default 8080) → http://localhost:APP_PORT.
• Frontend API target: VITE_API_BASE_URL in the root .env — the single environment file used for Docker, the install/update scripts, and npm run dev (dashboard/vite.config.ts points its envDir back at this file, and the Docker build copies it into the image) — defaults to https://reqres.in/api. Like all VITE_* variables it's inlined at build time, not read at container start.
• install/update never overwrite an existing .env; only new keys get added, with your existing values left alone.

Full details (Docker/Nginx internals, ports, every environment variable, VERSION, native mode, troubleshooting) live in dashboard/README.md.

Login Credentials

NOTE: Use this username and password to Login!

• Username: iqvdashboard
• Password: 2018

features

• customizable UI using Tailwindcss and Ant Design.
• Single page application using React Router.
• Mock API request using reqres.
• Powerful layout and table using @ant-design/pro-components.
• Code splitting and lazy loading component using @loadable/component.
• State management using react-redux and @reduxjs/toolkit.
• Persistent redux state using redux-persist.
• Loading progress bar using nprogress.
• ESLint and Prettier enabled.
• Option to enable Progressive Web App (PWA). (Only available in production build)
• Axios interceptor enabled to handle API authorization.
• Automated workflow for checking new Pull Request.

Usage (local development)

• Clone the project and change directory.

  git clone https://github.com/iBz-04/Dashboard-starter.git
  cd Dashboard-starter
  

• Install dependencies. npm is this repo's canonical package manager (see dashboard/README.md for why).

  cd dashboard
  npm install
  

• Create your environment file.

  ReqRes now requires a free API key for all /api/* requests.

  1. Get a key from app.reqres.in/api-keys
  2. Copy .env.example to .env
  3. Paste your key into VITE_REQRES_API_KEY

  cp .env.example .env
  

• Run dev server.

  npm run dev
  

• Then, visit http://localhost:5173

Feedback

If you have any feedback, please reach out to us ibz.04dev@gmail.com

Author

• @iBz-04