Introduction to CEIE

What is CEIE?

Controlled Environment Integration Engine (CEIE) is a Git workflow automation tool designed to streamline the software development lifecycle by introducing a structured, multi-layered Git repository setup.

It ensures a controlled and isolated workflow, reducing conflicts, improving collaboration, and automating essential version control tasks.

Why CEIE?

1. Standardized Git Workflow
Many development teams struggle with maintaining an organized Git workflow. CEIE enforces a three-layered Git approach, ensuring that:
✅ No one directly modifies the Main branch.
✅ Changes go through Controlled Environment for review.
✅ Developers can experiment freely in the Isolated Environment branch.

2. Automated Repository Setup
CEIE automates repository setup, eliminating the need for manually creating branches, configuring remotes, or setting up review processes. This helps teams save time and reduce errors.

3. Seamless Collaboration
By enforcing a structured development process, CEIE ensures that:
✔ Changes are reviewed before merging into production.
✔ Developers can work independently without affecting others.
✔ Code conflicts are minimized.

4. Easy to Use
Developers can set up CEIE with just a single command, making it an intuitive and developer-friendly tool.

5. Built with Kotlin for Efficiency
CEIE is powered by Kotlin, providing:
✅ Robust error handling
✅ High performance
✅ Better maintainability

How CEIE Works?

CEIE provides a custom Git command, git setup-ceie, which automatically:
✅ Initializes a Git repository (if not already initialized).
✅ Creates the Main, Controlled Environment, and Isolated Environment branches.
✅ Configures a structured push/pull mechanism.
✅ Enables a systematic code review process before merging into the Main branch.

Who Should Use CEIE?

CEIE is designed for:
✔ Developers who want a clean and structured Git workflow.
✔ Teams looking to enforce review-based development processes.
✔ Open-Source Contributors who want to streamline PRs and merges.
✔ CI/CD Engineers looking for a Git-based pre-deployment system.

Conclusion

CEIE redefines Git repository management by providing a structured, automated workflow.
It helps developers eliminate manual Git setup, improve collaboration, and reduce errors while keeping development seamless and efficient.

🚀 With CEIE, development becomes more structured, organized, and hassle-free! 🚀

File Structure

The Controlled Environment Integration Engine (CEIE) follows a structured file organization to ensure modularity, clarity, and maintainability.

Each component serves a distinct purpose, making it easier to navigate and extend CEIE's functionality. Below is the core directory structure of CEIE:

📂 CEIE/
   ├── src/ (Source code for CEIE, written in Kotlin)
   │   ├── main/ (Main application logic)
   │   │   ├── ceie/ (Core functionality and logic)
   │   │   ├── git/ (Git automation and commands)
   │   │   ├── utils/ (Helper functions and reusable utilities)
   │   │   ├── config/ (Configuration files and constants)
   │   ├── test/ (Unit and integration tests)
   ├── docs/ (Documentation files for CEIE)
   ├── gradle/ (Gradle-related configurations)
   ├── .gitignore (Git ignore rules)
   ├── README.md (Project documentation overview)
   ├── build.gradle.kts (Gradle build configuration in Kotlin)
   ├── settings.gradle.kts (Project settings for Gradle)
   ├── version.properties (Versioning system for CEIE)

Breakdown of Key Directories

1. src/ - Source Code Directory
This is the primary directory where CEIE’s source code resides. It contains two subdirectories:
✅ main/ - Houses the core implementation, including CEIE logic, Git commands, utilities, and configuration.
✅ test/ - Contains unit and integration tests to ensure stability and correctness.

2. ceie/ - Core CEIE Logic
This subfolder inside main contains all the primary logic powering CEIE, such as:
✔ Parsing Git commands
✔ Managing repository structures
✔ Handling controlled and isolated environments

3. git/ - Git Automation
This directory is responsible for automating Git operations within CEIE, such as:
✔ Creating and managing branches
✔ Automating push/pull operations
✔ Enforcing workflow constraints

4. utils/ - Helper Functions
Contains reusable functions that help with logging, error handling, and data processing.

5. config/ - Configuration Files
Stores constants and environment settings that make CEIE easily adaptable.

6. docs/ - Documentation
Holds all relevant documentation files for CEIE.

7. Gradle Files - Build System
CEIE uses Gradle as its build tool. The files build.gradle.kts and settings.gradle.kts define dependencies, project configurations, and build logic.

8. version.properties - Version Management
CEIE follows a dynamic versioning system, and this file stores the current version and build number.

Conclusion

The structured file system of CEIE ensures that all components are well-organized, making the project scalable, modular, and easy to maintain.
By following this well-defined hierarchy, developers can quickly understand and extend CEIE's functionality without confusion.

🚀 With CEIE’s organized structure, development and maintenance become effortless!

Installation

Setting up Controlled Environment Integration Engine (CEIE) requires two main steps:
✅ Installing Git Setup CEIE – This initializes and structures your repository.
✅ Installing CEIE – This enables CEIE’s core functionality.

1. Installing Git Setup CEIE

The Git Setup CEIE package automates the initial repository setup with predefined branches.

📌 Prerequisites
Before installing Git Setup CEIE, ensure you have the following installed:
✔ Git – Version control system (Install from [git-scm.com](https://git-scm.com/))
✔ Node.js (NPM) – Required for running `npx` commands (Install from [nodejs.org](https://nodejs.org/))

🔧 Installation Steps
1️⃣ Open your terminal or command prompt.
2️⃣ Run the following command to initialize a CEIE-compatible repository:
npx git-setup-ceie 3️⃣ This will:
✅ Create a repository structure with three default branches:   
➝ main (Stable branch for releases)
   ➝ controlled-environment (For team reviews)
   ➝ isolated-environment (For local development, not merged directly into main)
✅ Set up necessary project configurations.
✅ Initialize the repository for CEIE compatibility.

🎯 Verifying Installation
Run the following command to check if the repository was initialized correctly:
git branch You should see: main controlled-environment isolated-environment ✅ If you see these branches, Git Setup CEIE is installed successfully!

2. Installing CEIE

Once Git Setup CEIE is configured, the next step is to install CEIE itself.

📌 Prerequisites
Ensure the following dependencies are installed:
✔ Java (JDK 11+) – Required for Kotlin-based projects (Download JDK)
✔ Gradle – Build automation tool (Install Gradle)
✔ Kotlin Compiler – Needed for executing CEIE (Install Kotlin)

🔧 Installation Steps
1️⃣ Open a terminal in the root directory of your initialized repository.
2️⃣ Run the following command to install CEIE via npm:
npx ceie 3️⃣ This will:
✅ Download the latest CEIE package.
✅ Configure CEIE’s environment and dependencies.
✅ Set up CEIE to work with the predefined branches.

🎯 Verifying Installation
To confirm CEIE is installed, run:
ceie --version If it returns a version number, CEIE is successfully installed! 🚀

Conclusion

✅ Git Setup CEIE ensures your repository follows the structured CEIE workflow.
✅ CEIE brings automation, integration, and controlled development environments.

🚀 With just a few commands, you are now ready to use CEIE for seamless project management!

1. Start with the production build:

npm run-script build

2. Copy everything within the output folder (build/) to a folder on the server.

🚀 Why NPM?
We chose NPM as the distribution platform for CEIE due to its global reach, ease of accessibility, and seamless integration with modern development workflows.

✔ No Manual Setup – CEIE is instantly available without downloading extra files.
✔ Version Control – Developers always get the latest stable version.
✔ Cross-Platform – Works on any system with Node.js installed.

💡 The Power of npx ceie

Using npx ceie, users can execute CEIE directly without installing it globally.
Why is this important?
✔ Eliminates outdated versions lingering on a system.
✔ Always fetches the latest version, ensuring up-to-date functionality.
✔ Simplifies onboarding – just run and use!

With NPM, CEIE remains lightweight, instantly accessible, and always ready for integration. 🚀