Getting Started
Get up and running with PrintChecks in under 5 minutes.
Installation
Choose the package that fits your needs:
bash
npm install @printchecks/vuebash
npm install @printchecks/corebash
npm install @printchecks/web-componentsbash
pnpm add @printchecks/vuebash
pnpm add @printchecks/corebash
pnpm add @printchecks/web-componentsYour First Check
With Vue 3
vue
<script setup>
import { usePrintChecks } from '@printchecks/vue'
import { ref } from 'vue'
const { checks, bankAccounts, createCheck, createBankAccount } = usePrintChecks()
// Create a bank account first
const bankAccount = await createBankAccount({
name: 'Business Checking',
routingNumber: '123456789',
accountNumber: '987654321',
bankName: 'First National Bank',
accountType: 'checking'
})
// Create a check
const check = await createCheck({
checkNumber: 1001,
date: new Date(),
payee: 'Acme Corporation',
amount: 1250.00,
memo: 'Invoice #12345',
bankAccountId: bankAccount.id
})
console.log('Check created:', check)
</script>
<template>
<div>
<h1>My Checks</h1>
<ul>
<li v-for="check in checks" :key="check.id">
Check #{{ check.checkNumber }} - {{ check.payee }} - ${{ check.amount }}
</li>
</ul>
</div>
</template>With Core Library
typescript
import { PrintChecksCore } from '@printchecks/core'
// Initialize the core library
const printChecks = new PrintChecksCore()
// Create a bank account
const bankAccount = await printChecks.bankAccounts.create({
name: 'Business Checking',
routingNumber: '123456789',
accountNumber: '987654321',
bankName: 'First National Bank',
accountType: 'checking'
})
// Create a check
const check = await printChecks.checks.create({
checkNumber: 1001,
date: new Date(),
payee: 'Acme Corporation',
amount: 1250.00,
memo: 'Invoice #12345',
bankAccountId: bankAccount.id
})
console.log('Check created:', check)
// List all checks
const allChecks = await printChecks.checks.list()
console.log('All checks:', allChecks)With Web Components
html
<!DOCTYPE html>
<html>
<head>
<title>PrintChecks Example</title>
</head>
<body>
<h1>Check Printing</h1>
<!-- Bank Account Form -->
<bank-account-form></bank-account-form>
<!-- Check Form -->
<check-form></check-form>
<!-- Check Preview -->
<check-preview check-id="check-1"></check-preview>
<script type="module">
import '@printchecks/web-components'
// Listen for events
const checkForm = document.querySelector('check-form')
checkForm.addEventListener('check-created', (event) => {
console.log('Check created:', event.detail)
})
</script>
</body>
</html>Configuration Options
PrintChecks can be configured with custom storage adapters, encryption, and more:
typescript
import { PrintChecksCore, SecureStorageAdapter } from '@printchecks/core'
const printChecks = new PrintChecksCore({
storage: new SecureStorageAdapter({
encryptionKey: 'your-encryption-key',
storagePrefix: 'my-app'
})
})Next Steps
Now that you have PrintChecks set up, explore these guides:
- Bank Accounts - Managing multiple bank accounts
- Checks - Advanced check features
- Vendors - Vendor management
- Receipts - Creating itemized receipts
- Encryption - Securing sensitive data
- Storage Adapters - Custom storage solutions
Examples
Check out our examples section for more detailed code examples:
Need Help?
- Browse the User Guide
- Check the API Reference
- Read the FAQ
- View the GitHub Repository