Firmansyah Factor Starter-kit Playground

"Welcome to the Firmansyah Factor Starter-kit Playground GitHub repository. This repository is designed for learning and experimenting with the following components:

1. Factor FreeMarker Mindmap and Xmind Software Tool:

   • To facilitate a swift understanding of Apache FreeMarker 2.3.26, which serves as our template engine, we have provided a detailed mind map. You can find more information in this link.

2. Factor Eclipse IDE Snippets XML Files:

   • These files are essential for storing and managing code snippets or templates that can be easily incorporated into your FreeMarker template source code. These snippets can encompass commonly used code fragments or templates for recurring code patterns. They streamline your development workflow by enabling you to quickly insert boilerplate code or common constructs without manual typing. You can find additional details in this link.

3. Factor FreeMarker Template Examples:

   • This collection comprises template files that can be modified and tested for rendering using the Factor Eclipse Plugin. These template examples also offer guidance on utilizing the "Content Assist of The Factor FreeMarker" for efficient template development. Note that Content Assist functions optimally when the template is opened through the Factor Eclipse Plugin. Further details can be found in this link.

Prerequisites:

To make the most of this resource, ensure you have the following prerequisites in place:

1. Eclipse IDE.
2. The Factor Eclipse Plugin.
3. A valid license key.
4. Proficiency in utilizing the various editor features provided by The Factor Eclipse Plugin."

How to get Eclipse IDE

You can download and install the Eclipse Integrated Development Environment (IDE) by following these steps:

1. Visit the Eclipse Website: Go to the official Eclipse website at https://www.eclipse.org/.

2. Choose Your Eclipse IDE Flavor: Eclipse offers different IDE flavors tailored for various programming languages and development needs. The most common ones are Eclipse IDE for Java Developers, Eclipse IDE for Java EE Developers, Eclipse IDE for C/C++ Developers, Eclipse IDE for PHP Developers, and more. Choose the one that best suits your development requirements.

3. Download Eclipse: Click on the download link for the Eclipse IDE flavor you've selected. You will be redirected to a download page.

4. Select Your Download: On the download page, you will often find different download options, such as different versions of Eclipse IDE and download mirrors. Choose the appropriate version for your operating system (e.g., Windows, Linux, macOS) and click on the download link. Be sure to select the version that matches your system architecture (32-bit or 64-bit).

5. Download the Installer: Eclipse now offers an installer, which simplifies the installation process. You can choose to download the installer (recommended) or download the package as a zip file. The installer provides a user-friendly way to manage Eclipse installations and plugins.

6. Run the Installer or Extract the Zip File: If you downloaded the installer, run it, and it will guide you through the installation process. If you downloaded the zip file, extract its contents to a directory of your choice.

7. Launch Eclipse: Once the installation is complete or the zip file is extracted, you can launch Eclipse by running the eclipse executable file located in the Eclipse directory.

8. Workspace Selection: When you first run Eclipse, it will ask you to select a workspace directory. This is where your projects and configuration settings will be stored. You can choose the default workspace or specify a different location.

9. Start Developing: You are now ready to start using Eclipse for your development projects. You can create new projects, import existing ones, and install additional plugins to enhance your development environment.

Eclipse is a highly extensible IDE, so you can customize it with various plugins and extensions to support different programming languages and development tasks. Additionally, you can check for updates and manage plugins via the Eclipse Marketplace, which is accessible from the Eclipse IDE itself.

Remember to ensure that you have Java installed on your system, as Eclipse is a Java-based application, and it requires a Java Runtime Environment (JRE) or a Java Development Kit (JDK) to run.

How to install The Factor Eclipse Plugin via "Install New Software..."

Please note that the process may vary slightly depending on your specific Eclipse version and configuration. Additionally, it's essential to ensure that the update site URL (https://firmansyah-github.github.io/firmansyah-factor-updates/) is indeed the correct update site for the Factor Eclipse Plugin, as using an incorrect URL can lead to installation issues.

To install The Factor Eclipse Plugin via "Install New Software" using a specific update site (in this case, https://firmansyah-github.github.io/firmansyah-factor-updates/), follow these steps:

1. Open your Eclipse IDE.

2. Go to the "Help" menu at the top of the Eclipse window.

3. Select "Install New Software" from the dropdown.

4. In the "Available Software" dialog, click the "Add" button to add a new software site.

5. In the "Add Repository" dialog, provide a name for the update site (e.g., "Factor Eclipse Plugin") and enter the URL https://firmansyah-github.github.io/firmansyah-factor-updates/ in the "Location" field. Click "OK."

6. The update site should now appear in the "Work with" dropdown. Select it from the dropdown.

7. You should see the available features and plugins from the update site. Select the Factor Eclipse Plugin from the list.

8. Click "Next" to review the installation details.

9. Review the details, click "Next" again, and then accept the terms of the license agreement.

10. Click "Finish" to start the installation.

11. Eclipse will download and install the Factor Eclipse Plugin. After the installation is complete, it will prompt you to restart Eclipse. Go ahead and restart Eclipse.

The Factor Eclipse Plugin should now be successfully installed via the specified update site.

How to get a valid license key.

After get Eclipse IDE and The Factor Eclipse Plugin, you need to get a valid license key with following steps:

1. Open your Eclipse IDE.

2. Go to the "Preferences..." menu at the top of the Eclipse window.

3. Select "Firmansyah Software Licenses" from the left tree menu.

4. On right side panel, select "The Factor (Firmansyah Advanced CRUD Generator) X.Y.Z.vYYYYMMDD-HHMM".

5. Click "Request License" button.

6. Fill all the required information on the pop up dialog window form. You can choose the license type "Free" or ""Commercial".

7. Click "Send Email" button.

8. Kindly await an email from factor.license@gmail.com. For the Free license, you will receive a license key that grants a 30-day trial period with a table limit of 3 tables and a maximum of 3 fields per table. If you are interested in obtaining a commercial license, you will receive an email for payment request. Upon confirmation of payment, a second email will be sent to you containing the one-year subscription license key.

How to Install a Valid License Key

After obtaining a valid license key, you can install it by following these steps:

1. Launch your Eclipse IDE.

2. Navigate to the "Preferences..." menu at the top of the Eclipse window.

3. In the left-hand navigation menu, select "Firmansyah Software Licenses."

4. Click the "Add License..." button.

5. Locate your valid license key on your local system, and then click "Open."

6. If the license key is valid, its information will be added and displayed under the label "The Factor (Firmansyah Advanced CRUD Generator) X.Y.Z.vYYYYMMDD-HHMM."

7. Click the "Apply and Close" button to save your license key settings.

8. You are now ready to utilize The Factor Eclipse Plugin.

"Mastering the Effective Use of the Varied Editor Features Offered by The Factor Eclipse Plugin"

"Please view the YouTube video by following this link: https://youtu.be/jFHrv93ieGQ.

This video is organized into various sections:

1. Agenda of This Video Content (0:00): Watch here.

2. The Factor Eclipse Plugin Installation (Skip this section) (1:10): Skip to this part.

3. Model Editor - Database Configuration (3:31): View here.

4. Model Editor - Table Configuration (11:12): Go to this section.

5. Model Editor - Field Configuration (16:50): Jump to this part.

6. Template Editor - Directory Configuration (20:09): Access here.

7. Template Editor - Template Configuration (24:43): Navigate to this segment.

8. Template Editor - Placeholder Configuration (30:04): Explore this portion.

9. XML Editor (46:33): Visit this part."

The Factor Templates Complete Project Example

1. Quarkus Backend Templates: GitHub Repository: https://github.com/firmansyah-github/firmansyah.template.quarkus.git