https://github.com/appsfortableau/dashpets
https://github.com/appsfortableau/dashpets
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/appsfortableau/dashpets
- Owner: appsfortableau
- License: gpl-3.0
- Created: 2024-11-14T19:24:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-25T16:04:13.000Z (4 months ago)
- Last Synced: 2026-04-05T17:44:01.023Z (3 months ago)
- Language: TypeScript
- Size: 928 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DashPets
**DashPets** transforms your data into a cute, interactive world filled with pets. With DashPets, you can filter, interact, and have fun while keeping your dashboard lively and engaging.
## Features
- Generate pets based on category data.
- Assign size to pets based on measures.
- Hatch pets into eggs if their target isn't reached.
- Fully interactive: hover, move, and tooltip animations.
## Getting Started
### Prerequisites
- **Node.js** (>=18.x)
- **Yarn** package manager
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/dashpets.git
cd dashpets
```
2. Install dependencies:
```bash
yarn install
```
### Running the Development Server
To start a local development server:
```bash
yarn dev
```
This will run a Vite-powered development server for fast builds and hot module replacement.
### Building for Production
To create a production-ready build:
```bash
yarn build
```
This will:
1. Use TypeScript to type-check and transpile the source code.
2. Use Vite to bundle and optimize the assets for the `dist` folder.
The output will be stored in the `dist/` directory.
### License
This project is protected under the MIT License. See [LICENSE](LICENSE) for details.
## Contributing
Feedback and ideas are welcome! Use the GitHub **issues** and **pull requests** (PR) system to submit:
- Bug reports
- Feature suggestions
- Code contributions
Make sure to follow the [Contributing Guidelines](CONTRIBUTING.md) (add one if needed) when submitting a PR.
## Acknowledgments
- Built using [Vite](https://vitejs.dev).