Template for SvelteKit with Tauri, Biome, Tailwind, and More

Overview

This repository provides a powerful template combining SvelteKit with Rolldown, Tauri using Servo, Biome, Tailwind CSS, ShadCn, and Bun. This setup is designed for developers looking to build modern web applications with a focus on performance and flexibility.

Features

• SvelteKit: A framework for building Svelte applications with routing, server-side rendering, and more.
• Rolldown: A tool for creating smooth animations and transitions in your web apps.
• Tauri: A framework for building small, fast binaries for all major desktop platforms.
• Servo: A web browser engine designed for high performance and safety.
• Biome: A modern JavaScript and TypeScript linter and formatter.
• Tailwind CSS: A utility-first CSS framework for creating custom designs.
• ShadCn: A component library built on top of Tailwind CSS for faster development.
• Bun: A modern JavaScript runtime that focuses on speed and efficiency.

Getting Started

To get started with this template, clone the repository and install the necessary dependencies.

Clone the Repository

git clone https://github.com/Gatmovis/template-sveltekit-rolldown-tauri-servo-biome-tailwind-shadcn-bun.git
cd template-sveltekit-rolldown-tauri-servo-biome-tailwind-shadcn-bun

Install Dependencies

Use Bun to install the dependencies:

bun install

Run the Development Server

Start the development server with the following command:

bun run dev

You can view your application at http://localhost:3000.

Building for Production

To build your application for production, use the following command:

bun run build

This command will create an optimized version of your application in the build directory.

Creating a Tauri Application

To create a Tauri application, you will need to set up Tauri in your project. Follow these steps:

1. Install Tauri CLI: If you haven't already, install the Tauri CLI globally:

   cargo install tauri-cli
   

2. Initialize Tauri: Run the following command to initialize Tauri in your project:

   tauri init
   

3. Run Tauri: You can now run your Tauri application:

   tauri dev
   

Styling with Tailwind CSS

This template uses Tailwind CSS for styling. You can customize your styles by editing the tailwind.config.js file. To apply styles, use the utility classes provided by Tailwind.

Using ShadCn Components

ShadCn offers a collection of pre-built components that integrate seamlessly with Tailwind CSS. To use these components, simply import them into your Svelte files.

Example:

<script>
  import { Button } from 'shadcn-svelte';
</script>

<Button variant="primary">Click Me</Button>

Adding New Features

You can extend this template by adding new features or components. Here are some ideas:

• State Management: Integrate a state management library like Svelte Store or Zustand.
• Routing: Use SvelteKit's built-in routing or add a custom router.
• API Integration: Connect to an external API to fetch data.

Testing Your Application

To ensure your application works as expected, write tests using your preferred testing framework. This template does not include tests by default, so you will need to set up your testing environment.

Deployment

For deployment, you can use platforms like Vercel, Netlify, or GitHub Pages. Make sure to follow the specific instructions for each platform.

Releases

For the latest releases and updates, visit the Releases section. Download and execute the latest version to stay up-to-date.

Topics

This repository covers the following topics:

• Bun: A modern JavaScript runtime.
• Servo: A fast and secure web browser engine.
• ShadCn: A component library for rapid development.
• Svelte: A framework for building user interfaces.
• SvelteKit: A framework for building Svelte applications.
• Tailwind: A utility-first CSS framework.
• Verso: A potential future feature for enhanced functionality.

Contributing

Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request.

Steps to Contribute

1. Fork the repository.
2. Create a new branch for your feature.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, please reach out via the repository's issue tracker.

Acknowledgments

• Thank you to the creators of SvelteKit, Tauri, Tailwind CSS, and all the other technologies used in this template.
• Special thanks to the open-source community for their contributions.

For further information, refer to the Releases section. Download and execute the latest version to leverage all the features of this template.