Tapirio Toolkit

A simple starter kit for building robust & SEO-friendly websites with blogging capabilities. Foundation built with ExpressJS, Pug, Sass, Bootstrap. There is no reliance upon jQuery.

Key Features:

• Bun-powered runtime - Fast package management and execution
• Zero jQuery dependency - Modern vanilla JavaScript approach
• Markdown & HTML support - Write blog posts in either format with markdown-it parser
• SEO-optimized - Meta tags, semantic HTML, and clean URL structure out of the box
• Automatic sitemap generation - XML sitemap created and updated automatically
• RSS feed generation - Built-in RSS feed for blog content syndication
• Hot reload development - Instant feedback during development
• Flexible templating - Pug templates with component-based architecture
• Bootstrap 5 integration - Responsive design system with custom Sass variables
• Deployment-ready - Pre-configured for Vercel and Google App Engine
• CLI scaffolding - Interactive project setup with create-tapirio
• JSON-based content - Simple content management via preferences.json

Quick Start with CLI (Recommended)

The easiest way to create a new Tapirio project:

npx create-tapirio my-website

The CLI wizard will:

• Ask for your website name, description, and author
• Configure social links (optional)
• Set up your project with a clean boilerplate
• Automatically start the dev server

That's it! Your site will be running at http://localhost:3504.

CLI Options

npx create-tapirio my-website          # Interactive setup wizard
npx create-tapirio my-website --skip-setup   # Skip wizard, use defaults
npx create-tapirio --help              # Show all options

Manual Setup

If you prefer to clone the repo directly:

git clone https://github.com/teamzork/tapirio.git
cd tapirio
mv content/preferences-default.json content/preferences.json
bun install
bun run dev

Proceed to http://localhost:3504

Re-run Setup Wizard

Already have a project? Run the setup wizard anytime:

bun run setup

Available Scripts

Command	Description
bun run dev	Start development server with hot reload
bun run setup	Run the interactive setup wizard
bun run start	Start production server
bun run build	Build SCSS for production
bun run test	Run tests
bun run admin	Start admin panel

Deployment

Vercel (Recommended)

This project is configured for seamless Vercel deployment:

# Install Vercel CLI
bun add -g vercel

# Deploy
vercel

Or connect your GitHub repository to Vercel for automatic deployments.

Google App Engine

For GCP deployment, use the included app.yaml configuration.

Tech Stack

• Runtime: Bun
• Framework: Express.js
• Templates: Pug
• Styling: Sass + Bootstrap 5
• Markdown: markdown-it