Shepherd-dashboard

This project provides a visually guided dashboard experience using Shepherd.js (https://blog.shepherdpro.com/). It's designed to enhance user onboarding and engagement with interactive tutorials and step-by-step guides.

Hi, I'm Hitansh! 👋

Tech Stack

React, Redux, TailwindCSS Node, Express , Shepherd.js , intro.js

Screenshots

App Screenshot ![App Screenshot](![image](Screenshot 2024-06-04 124025 ))

Installation

  1. Prerequisites:

Node.js and npm (or yarn) installed on your system. You can download them from https://nodejs.org/en

Run Locally

Clone the project

  git clone https://github.com/Hitanshuser50/Shepherd-dashboard.git

Go to the project directory

  cd Shepherd-dashboard

Install dependencies

  
npm install  # or yarn install

Start the server

  npm start  # or yarn dev (depending on your preference)

License

MIT

Features

  • Light/dark mode toggle
  • Live previews
  • Fullscreen mode
  • Cross platform

API Reference

Get all items

  GET /api/items
Parameter Type Description
api_key string Required. Your API key

Get item

  GET /api/items/${id}
Parameter Type Description
id string Required. Id of item to fetch

Badges

Add badges from somewhere like: shields.io

MIT License GPLv3 License AGPL License