Getting Started

Welcome to the comprehensive documentation for the @tanglemedia packages, a suite of tools designed to enhance your Svelte development experience. These packages are meticulously crafted to streamline the development process, improve code quality, and ensure seamless integration with other libraries. This documentation aims to provide a clear, concise, and informative guide to utilizing these internal packages effectively in your projects.

# Overview

The @tanglemedia packages encompass a range of functionalities, with currently 8 packages, including UI components, layout management, and integration with external services like Marker IO, and much more. These packages are built on top of established libraries such as Flowbite-Svelte, ensuring compatibility and seamless integration with your Svelte applications. Whether you're looking to enhance your application's user interface, manage layouts efficiently, usage of easy to manage queries, seamlessly integrate with API and SDKs(Directus SDK), or integrate advanced features like Marker IO, these packages are designed to meet your needs.

# Key Features

• UI Components: A collection of simple yet effective UI components built on Flowbite-Svelte, offering a wide range of components to create stunning frontends.
• Layout Management: Comprehensive solutions for managing the layout and style settings of your Svelte application, including responsive design and dynamic styling.
• Marker IO Integration: Automatic integration of Marker IO into your application, enabling powerful issue tracking and reporting capabilities.
• Directus-Auth: Easy implementation of Sveltekit and Directus SDK integration, using services files to easy management and integration with YML files as well.

# Open-Source and Contribution

The @tanglemedia packages are actively maintained and updated to ensure compatibility with the latest versions of Svelte and other related technologies. If you encounter any issues or have suggestions for improvements, please refer to the contribution guidelines provided in the documentation.

We welcome contributions from the community and encourage developers to share their experiences, report bugs, and suggest enhancements to help improve the packages further.

# Important Information

Most of @tanglemedia packages are built on top of Flowbite-Svelte, so the recommendation from the developers of the @tanglemedia packages are:

• If the internal @tanglemedia packages have the components or functionalities you are looking for, use it
• If the functionality or component you are looking for is not present in any of the @tanglemedia packages, look for it in Flowbite-Svelte library, they probably will have it.
• If no one has the component or feature you are looking for, make sure to develop it on your own, and make a PR to the packages repo Svelte-Starter, and one of the developers of the @tanglemedia packages will take a look at your new features and implement into the @tanglemedia packages.

# Package Dependencies

With the exception of the UI package, all @tanglemedia packages have dependencies on the Core package. This modular approach ensures a cohesive and efficient development experience.

# Contributing Guidelines

Mono-repo project with all the packages: Svelte-Starter

Before submitting a pull request, ensure the following steps are completed:

1. Format Code: Run pnpm run format to ensure consistent code style.
2. Lint Packages: Execute pnpm run lint-tangle to lint the packages.
3. Build: Run pnpm run build to compile the project.
4. Test: Perform pnpm run test to validate the changes.
5. Documentation: Update the documentation app to include your new component, functionality, or new changes.

These steps are crucial for maintaining code quality and facilitating the review process for main developers.