Installation Guide for Lime Portal

Requirements 📝

1. Ensure the customer's Lime Forms installation includes all the standard forms utilized by the portal.
2. Confirm that limepkg-ff-portal is installed in the Lime CRM solution.

Installation Steps 🚀

1. Create a New Local Lime Portal

• Operating System: Ubuntu
• Command:

  lime-project portal new
  

• Instructions: Choose the latest version and proceed with the usual portal creation steps.

2. Configure the .env File

• Lime Forms JS Link:

  MIX_FORMS_JS_URL=https://xx.lime-forms.com/js/ce/latest
  

  (Update the URL accordingly for deployment)
• URL Encryption:

  URL_ENCRYPTION_ENABLED=true
  URL_ENCRYPTION_KEY=YOUR_16_CHARACTER_KEY
  

3. Update the Domain Folder 🌐

• Source: Copy the domain folder from the template portal here.
• Action: Replace your existing Domain folder with the copied one.

4. Choose and Customize Templates 📂

• Available Templates:
• admin - Tool for administering installers
• apartment_building_form - FF flow
• building_power_form - FF flow
• fuse_and_service_change_form - FF flow
• fuse_change_form - FF flow
• helpdesk - Tool for visualizing and interacting with helpdesks
• merger_form - FF flow
• new_connection_form - FF flow
• partition_form - FF flow
• production_existing_service_form - FF flow
• production_of_new_service_form - FF flow
• profile_editable - Tool for administering logged-in user
• service_change_form - FF flow
• temporary_facility_form - FF flow

5. Select and Delete Unnecessary Templates ✂️

• Mandatory: Typically, admin, helpdesk, and profile_editable.
• Optional: Choose FF flows based on customer needs.

6. Configure Templates

• Form Slug Replacement:

• For each FF flow, replace the form slug in template.json (config.form_id) with the form ID from the customer's Lime Forms installation.

• Activate Templates in config.json:

• Specify active templates and customize styling per customer requirements.

7. Design the Start Page 🎨

• File: Start.vue
• Instructions: Add a proper start page design (e.g., logo) based on customer preferences.

8. Configure Helpdesk Template 🔧

• File: helpdesk -> template.json
• Instructions:
• Configure fields for list view and show view.
• Define filters for the list view.
• Configure helpdesk types (a code corresponds to a helpdesk type, often a field on the helpdesk type card).
• Define unique fields for specific codes and common properties for all flows.

---

With these steps, you should have a fully configured Lime Portal ready for your customer's needs! 😊🚀