Overview

The Svelte Lorca Template is a starter project for building modern cross-platform desktop apps in Go, HTML, and Svelte. It is a fork of the lorca-ts-react-starter project and provides developers with a convenient and efficient way to create desktop applications.

Features

• Cross-platform: The Svelte Lorca Template allows developers to build desktop applications that can run on multiple platforms, including Windows, macOS, and Linux.
• Go and Svelte Integration: The template seamlessly integrates Go and Svelte, providing a powerful framework for developing desktop apps with a combination of backend and frontend technologies.
• Easy Setup: Developers can quickly get started by cloning the repository and following a few simple steps to install the necessary dependencies.
• Development and Production Modes: The template offers scripts for running the application in development mode with hot reload and file watching, as well as building the application for production with optimized performance.

Installation

To install the Svelte Lorca Template, follow these steps:

1. Clone the repository: git clone https://github.com/bmw2621/svelte-lorca-template.git <NEWPROJECTNAME>
2. Navigate to the newly created directory: cd <NEWPROJECTNAME>
3. Install dependencies: yarn
4. Launch the app in development mode: yarn start
5. Read the code and start building your own app!

Additional scripts are available for different purposes:

• yarn dev: Starts the Svelte application in development mode with hot reload.
• yarn build: Builds the app for production, creating a single executable for the backend Go application.
• yarn test: Runs Go tests and Jest tests.
• yarn svelte:test: Runs frontend tests.
• yarn go:test: Runs backend tests.
• node ./scripts/setupTypeScript.js: Adds TypeScript support to the frontend project using the included Svelte Template script.

Summary

The Svelte Lorca Template is a versatile starter project for building cross-platform desktop applications using Go, HTML, and Svelte. It offers a range of features such as easy setup, development and production modes, and seamless integration of Go and Svelte. With the provided installation guide, developers can quickly get started and begin building their own desktop apps.