Skip to content

Quick Start

Welcome to K5M! This guide will help you get started with our projects.

Before you begin, make sure you have the following installed:

  • Bun - Fast JavaScript runtime
  • Git - Version control
  • A modern web browser
  • Terminal/command line access

Most K5M projects are designed to run locally without complex setup:

Terminal window
# Clone a project
git clone https://github.com/kmikeym/[project-name]
# Navigate to the project
cd [project-name]
# Install dependencies
bun install
# Run the project
bun run dev

If you need help:

  1. Check the project-specific documentation
  2. Review the reference guides
  3. Open an issue on GitHub
  4. Review the README files in each project

a K5M company