GitHub - codebude/takecode: A web viewer for massCode snippets (original) (raw)

A modern web interface for browsing and searching your massCode snippets with syntax highlighting, themes, and copy-to-clipboard functionality.

📜 Table of Contents

• 📸 Screenshot
• 🌐 Live Demo
• 💡 Motivation
• ⚠️ Affiliation & Disclaimer
• ✨ Features
• 🚀 Quick Start
  • Finding Your massCode Database
  • Using Docker Compose
  • Manual Docker Run
• 🔧 Development
• 🤝 Contributing
• 📄 License
• 📈 Star History

📸 Screenshot

Browse your massCode snippets with a clean, modern web interface featuring syntax highlighting, (regex-)search, dark-/light-mode and tabbed code fragments.

🌐 Live Demo

Check out the live demo at https://demo.take-code.dev/

💡 Motivation

I love massCode - it's an amazing code snippet manager that helps me organize and access my code snippets efficiently. However, sometimes I work on devices where I can't install the desktop client (like company laptops, shared computers, or restricted environments). To still have access to my snippets, I created takeCode - a lightweight web interface that works with massCode's database files.

⚠️ Affiliation & Disclaimer

This project is not affiliated with massCode in any way. I'm just a happy user of massCode and a developer with passion who wanted to extend the functionality for my own use cases. This project works with massCode's db.json database files, but besides that, there are no other touchpoints or official connections with the massCode project or its developers.

✨ Features

• 🔍 Search & Filter: Quickly find snippets by name, description, or content
• 🎨 Themes: Light, dark, and auto themes with smooth transitions
• 📋 Copy to Clipboard: One-click copying of code blocks with visual feedback
• 🌳 Tree Navigation: Browse snippets organized in folders
• 📱 Responsive Design: Works on desktop and mobile devices
• 🐳 Docker Ready: Easy deployment with Docker Compose

🚀 Quick Start

Finding Your massCode Database

takeCode works by reading your existing massCode db.json file. Here's how to locate it:

On Different Operating Systems:

• macOS: ~/Library/Application Support/masscode/db.json
• Windows: %APPDATA%\masscode\db.json (usually C:\Users\<username>\AppData\Roaming\masscode\db.json)
• Linux: ~/.config/masscode/db.json

For more details, check the massCode documentation on data storage.

Shared/Network Databases

You can also use takeCode with databases stored on network drives or shared locations. Simply mount the network drive and point the volume mapping to the shared db.json file path.

Using Docker Compose (Recommended)

1. Download the docker-compose.yml:
   wget https://raw.githubusercontent.com/codebude/takecode/main/docker-compose.yml
2. Edit the volume mapping: Open docker-compose.yml and update the volume path to point to your local massCode db.json file:
   volumes:

• /path/to/your/masscode/db.json:/data/db.json:ro

1. Run the application:
2. Open your browser:

Volume Mapping

The docker-compose.yml includes a volume mount that maps your local db.json file to the container:

volumes:

• ./db.json:/data/db.json:ro

Important: Update the left side (./db.json) to the actual path of your massCode database file. The volume is read-only to prevent accidental modifications to your data.

Configuration Options

takeCode supports environment variables for customization:

SEARCH_HIGHLIGHT_LIMIT

Controls how many search matches are highlighted per snippet.

• Default: 3
• Range: -1 to 9007199254740991 (JavaScript's Number.MAX_SAFE_INTEGER)
• Special value: -1 means highlight all matches (no limit)

Examples:

Highlight only the first 5 matches per snippet

environment:

• SEARCH_HIGHLIGHT_LIMIT=5

Highlight all matches (no limit)

environment:

• SEARCH_HIGHLIGHT_LIMIT=-1

Use default (3 matches)

No environment variable needed

SEARCH_TERM_MIN_LENGTH

Controls the minimum length of search terms required to perform a search.

• Default: 1 (match from first character on)
• Range: 1 to 9007199254740991 (JavaScript's Number.MAX_SAFE_INTEGER)
• Behavior: If the search term is shorter than this search will not be executed

Examples:

Require at least 2 characters for search

environment:

• SEARCH_TERM_MIN_LENGTH=2

Require at least 3 characters for search

environment:

• SEARCH_TERM_MIN_LENGTH=3

No minimum length (default)

No environment variable needed

Manual Docker Run

Using GitHub Container Registry

docker run -d -p 8080:80 -v /path/to/your/db.json:/data/db.json:ro ghcr.io/codebude/takecode:latest

Or using Docker Hub

docker run -d -p 8080:80 -v /path/to/your/db.json:/data/db.json:ro codebude/takecode:latest

🔧 Development Setup

If you want to contribute or modify the styles:

1. Install dependencies:
2. Build CSS and run dev server:
3. Build production CSS and update version:

🤝 Contributing

Found a bug or have a feature request? Feel free to:

• Open an issue
• Create a pull request
• ⭐ Star the repository if you find it useful!

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Try takeCode today and supercharge your snippet management! 🚀

📈 Star History