Getting Started
Installation
Set up Arkpad in your project with minimal configuration.
Prerequisites
- Node.js LTS (v20 or higher)
- npm, pnpm, or bun
- Git
Installing the Packages
React (Recommended)
npm install @arkpad/react @arkpad/coreVanilla JavaScript
npm install @arkpad/coreProject Setup
1. Clone the Repository
git clone https://github.com/arkcabin/arkpad.git
cd arkpad2. Install Dependencies
npm install3. Run Development Server
npm run devThis starts the demo app at http://localhost:5173.
Available Scripts
| Command | Description |
|---|---|
npm run dev | Start local development app |
npm run build | Compile all packages and app |
npm run test | Run automated tests |
npm run test:all | Run core + extension tests |
npm run lint | Run ESLint |
npm run typecheck | Run TypeScript checks |
npm run format | Format code with Prettier |
Environment Checklist
- Correct Node version installed (v20+)
- Package manager available
- Dependencies installed successfully
- Tests pass locally (
npm run test)