Website for the Open Rate Card Specification - Interconnect Made Easy
- 📚 Documentation: Complete specification rendered from the interconnect-made-easy repository
- 🛠️ Tools: Interactive tools for working with rate cards
- Validator: Validate rate card JSON against the specification
- Checksum: Add SHA-256 checksums to rate cards
- Builder: Build rate cards using a form interface
- Examples: View and load example rate cards
- 🎨 Modern Design: Built with Nuxt 3, Vue 3, and Tailwind CSS
- ☁️ Cloudflare Ready: Optimized for deployment on Cloudflare Pages
- Framework: Nuxt 3
- UI Framework: Vue 3
- Styling: Tailwind CSS
- Markdown: Marked
- Deployment: Cloudflare Pages
interconnect.exchange/
├── pages/ # Application pages
│ ├── index.vue # Home page
│ ├── tools.vue # Tools page
│ └── docs/ # Documentation pages
├── components/ # Vue components
│ ├── Header.vue # Site header
│ └── Footer.vue # Site footer
├── server/ # Server-side API
│ └── api/
│ ├── docs/ # Documentation API
│ └── tools/ # Tools API
├── docs-content/ # Git submodule (interconnect-made-easy)
└── assets/ # Static assets
- Node.js 18+
- npm or yarn
- Clone the repository with submodules:
git clone --recurse-submodules https://github.com/connexcs/interconnect.exchange.git
cd interconnect.exchange- Install dependencies:
npm install- Start the development server:
npm run devThe site will be available at http://localhost:3000
npm run buildnpm run generateThis project is configured for Cloudflare Pages deployment. The build command is:
npm run buildThe output directory is dist/.
The documentation is automatically rendered from the interconnect-made-easy repository, which is included as a git submodule in docs-content/.
To update the documentation:
git submodule update --remote docs-contentValidates rate card JSON documents against the Open Rate Card specification, checking for required fields and proper structure.
Generates SHA-256 checksums for rate cards using canonical JSON (RFC 8785) for integrity verification.
Interactive form-based builder for creating rate card JSON documents with all required fields.
Pre-filled examples demonstrating valid rate card structures that can be loaded into other tools.
Contributions are welcome! Please feel free to submit a Pull Request.
This project is part of the Open Rate Card Specification initiative by ConnexCS.