https://github.com/datopian/ckan-gw-explorer
A data explorer powered with the Graphic Walker framework and the CKAN Datastore API.
https://github.com/datopian/ckan-gw-explorer
Last synced: 2 months ago
JSON representation
A data explorer powered with the Graphic Walker framework and the CKAN Datastore API.
- Host: GitHub
- URL: https://github.com/datopian/ckan-gw-explorer
- Owner: datopian
- Created: 2025-08-11T08:44:20.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-08-30T02:39:26.000Z (7 months ago)
- Last Synced: 2025-10-21T16:49:20.929Z (6 months ago)
- Language: TypeScript
- Size: 674 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CKAN Graphic Walker Based Explorer
A React component library for visualizing CKAN datasets using Graphic Walker.
## 📁 Project Structure
```
ckan-gw-explorer/
├── packages/
│ ├── core/ # Main library package
│ │ ├── src/ # Source code
│ │ ├── dist/ # Built files
│ │ └── package.json
│ └── example/ # Example React app
│ ├── src/ # Example app source
│ └── package.json
├── package.json # Root workspace config
└── README.md
```
## 🚀 Quick Start
### Development
```bash
# Install all dependencies
npm install
# Build the library
npm run build
# Start the example app
npm run example
# Development with auto-rebuild
npm run example:dev
```
### Individual Package Commands
```bash
# Core library
npm run build --workspace=packages/core
npm run dev --workspace=packages/core
# Example app
npm run start --workspace=packages/example
```
## 📦 Available Scripts
### Root Level
- `npm run build` - Build the core library
- `npm run example` - Start example app
- `npm run example:dev` - Start example with auto-rebuild
- `npm run build:all` - Build all packages
- `npm run clean` - Clean all node_modules and dist
- `npm run install:all` - Install dependencies for all packages
### Core Package
- `npm run build --workspace=packages/core` - Build library
- `npm run dev --workspace=packages/core` - Watch mode
### Example Package
- `npm run start --workspace=packages/example` - Start example app
- `npm run dev-sync --workspace=packages/example` - Rebuild library
## 🔄 Development Workflow
1. **Make changes** to `packages/core/src/CkanGraphicWalker.tsx`
2. **Build library**: `npm run build`
3. **Example app** automatically uses the updated library
## Example of using the library
```tsx
import { CkanGraphicWalker } from "ckan-gw-explorer";
function DataExplorer() {
return (
);
}
export default DataExplorer;
```