Crowdin Custom File Format Boilerplate

The simplest possible Custom File Format app for Crowdin.

It implements support for INI, CONF, and CFG files in Crowdin with beautiful WYSIWYG preview for translators.

Features

• 📁 File Support: .ini, .conf, .cfg files
• 🎯 No Configuration: Just upload files - no settings screen needed
• 🔧 Minimalist: Just a few lines of actual logic
• 👁️ Preview: Shows translatable content to linguists with syntax highlighting

Quick Start

1. Setup Environment

Create a .env file with these variables:

# Your app's public URL (required for Crowdin to connect)
URL=https://your-domain.com

# Local development port
PORT=3000

# Crowdin App credentials (get these from Crowdin Developer Console)
CLIENT=your-crowdin-client-id
SECRET=your-crowdin-client-secret

# Database configuration (optional, for production deployments)
# DB_HOST=localhost
# DB_USER=your-db-user
# DB_PASSWORD=your-db-password
# DB_DATABASE=your-db-name

2. Install & Run

npm install
npm start

For development with auto-restart:

npm run dev

3. Use in Crowdin

1. Install app in your Crowdin project
2. Upload .ini/.conf/.cfg files

Dependencies

Runtime:

• @crowdin/app-project-module - Crowdin App framework
• serverless-http - Serverless deployment support
• ini - INI file parser

Development:

• nodemon - Auto-restart during development
• env-cmd - Environment variable management

Deployment

Serverless ready - works on AWS Lambda, Vercel, etc.

Docker:

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
EXPOSE 3000
CMD ["npm", "start"]

Examples

See examples/ directory:

• sample.ini - Full featured example with sections
• simple.conf - Basic key=value pairs