README.md

🌐 Alrayada Web

A production landing page for Alrayada Alarabiah built using Kobweb, a Kotlin web framework built on Compose HTML that targets Kotlin/JS.

---

  

📚 Table of contents

• ▶️ Run
• 📋 Development Prerequisites
• 📦 Export
• 🐞 Known issues
• 🍴Forking Guidelines
• 📜 Acknowledgments

📋 Development Prerequisites

• Kobweb CLI.
• JDK 11 or newer versions. Suggests Adoptium or Amazon Corretto.
• Suggests IntelliJ IDEA Community Edition installed using JetBrains Toolbox.

▶️ Run

To run in development mode:

$ git clone https://github.com/FreshKernel/alrayada-web.git --depth 1
$ (cd alrayada-web && kobweb run -p site --layout static)

For more details, refer to Kobweb static layout vs full stack sites.

📦 Export

To export the site for production:

$ cd site # Inside the repo root directory
$ kobweb export --layout static # Output in site/.kobweb/site 
$ kobweb run --layout static --env prod # To run the exported site

For more details, refer to Kobweb exporting and running.

🐞 Known issues

• Navigate to the privacy policy page using the menu, scroll to the very end, a NullPointerException will be thrown from the sections of previous page if the animations are enabled, specifically from the ObserveViewportEntered(), all listeners and events should be disposed when no longer needed.
• Rtl isn't supported yet, currently not a priority.
• Open the localized page URL (/en), navigate to the privacy policy page, refresh the page and will load the site default language.

🍴Forking Guidelines

This information is for internal use and should be replaced when forking or adapting this project.

• The details in the file SectionsConstants.kt especially the FORM_URL.
• The images related to the brand are in the assets directory.
• The naming in:
  • site.webmanifest, sitemap.xml.
  • The domain alrayada.net.
  • In the site's source code.
  • In the site's build.gradle.kts.

📜 Acknowledgments

• Kobweb - For providing essential tools for building web applications.
• Jetbrains - For their development tools, including IntelliJ IDEA Community Edition and Kotlin.
• FontAwesome - For the awesome icons.
• Tanbir Ahmed - For the design inspiration.