The Combine

A rapid word collection tool. See the User Guide for uses and features.

Table of Contents

1. Getting Started with Development
   1. Install Required Software
   2. Prepare The Environment
   3. Python
      1. Windows Python Installation
      2. Linux Python Installation
      3. macOS Python Installation
      4. Python Packages
   4. Load Semantic Domains
2. Available Scripts
   1. Running in Development
   2. Using OpenAPI
   3. Running the Automated Tests
   4. Import Semantic Domains
   5. Generate License Reports
   6. Inspect Database
   7. Add or Update Dictionary Files
   8. Cleanup Local Repository
   9. Generate Installer Script for The Combine
   10. Generate Tutorial Video Subtitles
3. Set Up Local Kubernetes Cluster
   1. Install Rancher Desktop
   2. Install Docker Desktop
   3. Install Kubernetes Tools
4. Set Up The Combine
   1. Install Required Charts
   2. Build The Combine Containers
   3. Set Up Environment Variables
   4. Install/Update The Combine
   5. Connecting to your Cluster
   6. Rancher Dashboard
5. Maintenance
   1. Development Environment
   2. Kubernetes Environment
6. User Guide
7. Continuous Integration and Continuous Deployment
   1. On Pull Request
   2. On Release
8. Production
9. Learn More

Getting Started with Development

Install Required Software

1. Clone this repo:

   git clone https://github.com/sillsdev/TheCombine.git
   

2. Chocolatey (Windows only): a Windows package manager.

3. Node.js 24 (LTS)

   • On Windows, if using Chocolatey: choco install nodejs-lts
   • On Ubuntu, follow this guide using the appropriate Node.js version.

4. .NET 8.0 SDK

   • On Ubuntu, if using Snap: sudo snap install dotnet-sdk --classic --channel 8.0/stable

5. MongoDB provides instructions on how to install the current release of MongoDB.

   • On Windows, if using Chocolatey: choco install mongodb

This is the beginning of the README. Read the rest at the original. Read the full README ↗