Cetin-Utils

Cetin-Utils is a comprehensive helper toolset tailored specifically for the CetinJS Framework, streamlining project workflows with efficient build, compression, and management utilities. Designed to work seamlessly with the CetinJS compiler, it ensures that your development processes are smooth and hassle-free.

Features

Key Functionalities

• Project Build Automation: Simplifies and automates the build process for your projects.
• Code Compression: Minifies and optimizes your files for better performance.
• Script Execution: Provides versatile utilities for running environments like web, mobile (Android), and development setups.

Compatibility

• Fully integrated with the CetinJS Framework.
• Can be adapted to other projects following similar structure and conventions.

Installation

NPM Installation

Install Cetin-Utils via NPM:

npm install cetin-utils

Usage

Leverage Cetin-Utils to simplify common tasks. You can also integrate its commands directly into your package.json scripts for seamless execution within your project.

Example package.json Scripts

"scripts": {
  "build": "node node_modules/cetin-utils/build.js",
  "web": "node node_modules/cetin-utils/run-build.js",
  "android": "node node_modules/cetin-utils/run-open-android.js",
  "core-check": "node node_modules/cetin-utils/run-check-cetin-core.js",
  "start": "node node_modules/cetin-utils/run-src.js"
}

Running Commands

1. Build Projects:

   npm run build

2. Run Web Environment:

   npm run web

3. Open Android Development Setup:

   npm run android

4. Start Development Server:

   npm run start

Cetin-Core Module States

Important Notice:

The @cetin-utils module requires the @cetin-core module to function properly.

For building and running npm run core-check, the @cetin-core module is required. Please ensure it is included.

5. Check Cetin Core:

   npm run core-check

| | | | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | Shows that Cetin-Core is present and up-to-date in your project | Shows that Cetin-Core is not present in your project, and the module needs to be installed |

| | | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | Shows that the Cetin-Core module exists, but it is not in your project, and it has been added | Shows that the Cetin-Core module is not up-to-date and needs to be updated |

Why Use Cetin-Utils?

• Efficiency: Automates repetitive tasks, allowing you to focus on development.
• Seamless Integration: Built for CetinJS, yet versatile enough to fit other compatible project structures.
• Lightweight: Designed with minimal overhead, keeping your project clean and fast.
• Adaptability: Extend or customize it for projects that share CetinJS's conventions.

Contributing

We welcome contributions! If you have feature ideas or improvements, feel free to:

• Open an Issue: Share your suggestions or bug reports.
• Submit a Pull Request: Contribute directly to the GitHub repository.

License

This project is licensed under the CC BY-NC-ND 4.0 License. See the LICENSE file for more details.

Additional Terms

The core components of the CetinJS framework are currently closed-source and encrypted. This means that the fundamental structure and internal workings of the framework are not shared with users. As a result, the core code of CetinJS will not be accessible or modifiable in an open manner.

However, CetinJS provides developers with the ability to create and develop projects. Users can leverage CetinJS to build high-performance and compatible applications for various projects.

You can create applications using the Core software and publish and distribute these applications under your brand name. Simply providing attribution to CetinJS is sufficient. Since the Core software is encrypted (because the project's direction is not yet clear, there are no commercial activities, and future plans are still uncertain), it is prohibited to crack or modify it, and attempting to redistribute it is also forbidden.

Developed with ❤️ by XertXetin 🚀 Me Force Technology.