https://github.com/valkey-io/valkey-admin
https://github.com/valkey-io/valkey-admin
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/valkey-io/valkey-admin
- Owner: valkey-io
- License: apache-2.0
- Created: 2025-08-06T21:15:44.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-12-19T23:18:16.000Z (25 days ago)
- Last Synced: 2025-12-21T05:54:53.039Z (24 days ago)
- Language: TypeScript
- Size: 33.1 MB
- Stars: 1
- Watchers: 0
- Forks: 4
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Valkey Admin
## Getting Started (Development)
### Start Valkey Cluster
1. From the root directory, run `tools/valkey-cluster/scripts/build_run_cluster.sh`.
1. This will build and run the cluster.
2. Master hostname will be `localhost`.
3. Master nodes ports will be `7001` - `7003`.
**Note:** If your computer's ip address changes the cluster will work in unexpected ways. To resolve this, you will need to delete the Docker containers and volumes of the cluster, then restart the cluster.
### Running the apps
1. Install all dependencies from the project root: `npm ci`
2. Run both server and frontend: `npm run dev`
## IDE Setup
### VSCode
The repository includes settings for the ESLint extension. Please install it.
**Note:** If you have a formatter i.e. Prettier, it could interfere with the ESLint extension. Please disable it from the workspace.
This requires ESLint v9.0.0 and above.
## Create DMG
You are able to build notarized or non-notarized Applications.
### Unnotarized Application
#### Overview
- Much faster build process.
- While you won't encounter any issues running this on the system that built it, distributing the DMG will lead to a `"Valkey Admin" is damaged and can't be opened` error when running the application. To bypass this, run `xattr -c ` in terminal to disable the quarantine flag.
#### Process
In the root directory, create a DMG by running `npm run package:mac:nosign`.
### Notarized Application
#### Overview
- Much slower build process (could be hours the first time, and up to 10 minutes consequently).
- Has additional requirements listed in `mac_build`.
#### Process
In the root directory, create a DMG by running `npm run package:mac`.