https://github.com/suiramdev/storedge-dashboard
🚀 A simple dashboard for Storedge, a headless CMS project for e-commerce
https://github.com/suiramdev/storedge-dashboard
Last synced: about 1 year ago
JSON representation
🚀 A simple dashboard for Storedge, a headless CMS project for e-commerce
- Host: GitHub
- URL: https://github.com/suiramdev/storedge-dashboard
- Owner: suiramdev
- Created: 2023-03-13T16:46:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T18:35:08.000Z (about 2 years ago)
- Last Synced: 2024-01-04T17:36:45.187Z (about 2 years ago)
- Language: TypeScript
- Homepage: https://storedge.suiram.dev
- Size: 716 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# storedge-dashboard
The graphical user interface for managing the [Storedge](https://github.com/suiramdev/storedge-core) CMS. This dashboard is designed to provide a seamless administrative experience for e-commerce platforms. Built with the modern Vite.js build tool and React framework, dashboard integrates shadcn-ui components to create a simple yet effective user interface, refined from initial custom designs in Figma.
## Features
- **Intuitive Interface**: A clean and responsive UI based on shadcn-ui, focusing on user experience and ease of use.
- **Fast Development**: Leveraging Vite.js for an optimized development experience with fast rebuilds.
- **React Framework**: Utilizing the robust React ecosystem for reactive state management and component-based architecture.
# Table of Contents
- [Try the Dashboard](#try-the-dashboard)
- [Access the Demo](#access-the-demo)
- [Limited Access](#limited-access)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Dashboard](#running-the-dashboard)
- [Building for Production](#building-for-production)
- [Architecture Overview](#architecture-overview)
- [Design Philosophy](#design-philosophy)
- [Contributing](#contributing)
- [License](#license)
## Try the Dashboard
Get hands-on experience with the dashboard by accessing our live demo. This is a great way to familiarize yourself with the interface and features without the need to set up a local environment.
### Access the Demo
To explore the dashboard:
1. Visit [storedge.suiram.dev](https://storedge.suiram.dev)
2. Log in using the following demo credentials:
- **Email**: `demo@storedge.com`
- **Password**: `storedge`
### Limited Access
For security reasons, the demo account is view-only and modifications are not permitted. This ensures the integrity of the demo experience for all users and protects the system from any unauthorized changes. We appreciate your understanding as we strive to maintain a secure and stable demonstration environment.
## Getting Started
To get started with the Storedge-Dashboard, clone this repository and navigate into the directory:
```bash
git clone https://github.com/suiramdev/storedge-dashboard.git
cd storedge-dashboard
```
### Prerequisites
Before you start, make sure you have Node.js installed on your system (preferably the latest stable version).
### Installation
Install the necessary packages using `pnpm`:
```bash
pnpm install
```
### Running the Dashboard
Start the development server with:
```bash
pnpm dev
```
Your dashboard will be available at `http://localhost:5173`.
### Building for Production
To build the dashboard for production, run:
```bash
pnpm build
```
This will generate the production files in the `dist` folder.
## Architecture Overview
The dashboard is designed as a single-page application (SPA) with the following key parts:
- **Vite.js**: Employs Vite.js for bundling and development tooling to provide a fast and modern development experience.
- **React**: Built with React to take advantage of its efficient update and rendering system.
- **shadcn-ui**: Implements shadcn-ui for a standardized and accessible component library.
## Design Philosophy
The design of Storedge-Dashboard was initially conceptualized in Figma. However, to streamline the development process and maintain simplicity, we have adopted shadcn-ui. This ensures that we can provide consistent updates and support without the overhead of maintaining a custom UI library.
## Contributing
Contributions to the Storedge-Dashboard are welcome. Please read our CONTRIBUTING.md file for instructions on how to make contributions.
## License
Storedge-Dashboard is licensed under the MIT License. See the LICENSE.md file for full license text.