Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Download Kudo api server

...

and extract it.

View file
namekudo api-server

...

.zip

To install all required dependencies you need to split terminal into 2 windows and work with both BackEnd(Server) and FrontEnd(ui) projects.

...

Code Block
  cd ./server
  npm install

Run Locally

FrontEnd: Go to App folder and run project

...

to check that server was executed try to view documentation url in the end of this /wiki/spaces/KUDOPARTNER/pages/3725492247

Integrate Editor to UI:

  1. Accessing Editor Settings Icon: Navigate to the UI where you wish to integrate the Editor. Look for the "Change Editor Setting" icon. This icon should be visible within the UI interface. Refer to the image provided for visual guidance.

     

    image-20240207-041854.pngImage Added
  2. Opening the Editor Settings Dialog: Click on the "Change Editor Setting" icon. This action will prompt a dialog box to appear on your screen. This dialog box will facilitate the modification of Editor settings.

  3. Modifying the Editor Server URL: Within the opened dialog box, locate the field labeled "Editor Server URL." This field allows you to specify the URL where the Editor server is hosted.

    • Example: Change the URL to match the location where your Editor server is hosted. For instance, if the Editor server is hosted locally on port 8081, the URL would be http://localhost:8081.

  4. Saving Changes: After updating the Editor Server URL to reflect your server's location, ensure to save the changes. Look for the "Save" button within the dialog box and click on it.

...

Performing Actions in the Interface

In the Editor interface, you can execute various actions such as creating a new folder, creating a new DWG file, or uploading a file. Follow these steps to perform these actions:

  1. Creating a New Folder:

    • Locate the option for creating a new folder within the User interface.

      create.pngImage Added
    • Click on the "Create New Folder" icon or button to initiate the folder creation process.

    • Provide a name for the new folder when prompted.

    • Press the "Create" button to confirm the creation of the new folder.

Creating a New DWG File:

  • To creating a new DWG file within the User interface.

    file.pngImage Added
  • Click on the "Create new file" icon to begin the process.

  • Select template to set default property or setting of the creating new drawing file.

  • Specify a name for the new DWG file when prompted.

  • Confirm the creation by clicking on the "Create" button.

 

Uploading a File:

  • To upload a file within the User interface.

    uplaod.pngImage Added
  • Click on the "Upload File" icon or button to initiate the file upload process.

  • Select the file you wish to upload from your local system using the file selection dialog that appears.

  • After selecting the file, confirm the upload by clicking on the "Open" button.

  • Your selected file will be uploaded.

 

Opening Files in the Editor:

To open files such as DWG, DXF, etc., within the Editor interface,

  • Click on the name of the file you want to open. This action triggers the opening process within the Editor.

Please refer this video:

...

FAQ

Can I add read databases like DynamoDb or AWS to this project?

Yes, you need to fork this repo and then add your data-base logic to places marked with // @emulate-db-request

Can I run this project without Ares Kudo Server installed?

Yes, but you will be able to navigate and browse folders, but editor will be inaccessibleImportant Note: Installation and Licensing Requirements

Before attempting to open files within the Editor interface, please ensure the following requirements are met:

  1. Editor Installation:

    • The Editor application must be installed on your local system. If it is not already installed, please download and install the Editor according to the provided installation instructions in /wiki/spaces/KUDOPARTNER/pages/1180827709.

  2. Editor Server Running:

    • Ensure that the Editor server is running on your local system. The Editor server facilitates the interaction between the Editor interface and the files you wish to open.

  3. Licensing Process:

    • Complete the licensing process for the Editor application. Proper licensing is necessary to access and utilize the full functionality of the Editor.

  4. Integration with Editor Server URL:

    • Confirm that the Editor interface is configured to connect to the Editor server URL provided during installation or setup. This ensures that files are opened within the Editor seamlessly.

 

Installation and Licensing Guide for Ares Kudo Editor

/wiki/spaces/KUDOPARTNER/pages/1180827709

This guide provides step-by-step instructions for installing the Ares Kudo Editor and completing the licensing process on your operating system.