Skip to content

Latest commit

 

History

History
160 lines (109 loc) · 5.98 KB

README.md

File metadata and controls

160 lines (109 loc) · 5.98 KB
Raw

Stargazers MIT License Release

EN: I am preparing JLPT(Japanese Language Proficiency Test) N1 now, this project is pretty lagging progress on development

JA: 日本語能力試験 N1 勉强中だから、このプロジェクトはものすごく低いペースで進めているなのですよ

CN: 学日语 N1 中，此项目可能进度极慢


Logo

sweather-widget

🌤 Lightweight weather widget made by Svelte & Electron for desktop devices 🌤

English · 简体中文 · 日本語

Directory

Introduction of Project

The image shown here is the index of this widget, click here to see more detailed screenshot for this project.

sweather-widget is a lightweight and less dependencies widget that compatible with desktop OSs, which is made by Svelte and Electron and almost everything is made manually. The weather data-source are from Free Weather API

(back to top)

Build With

  • Svelte
  • Electron
  • Sass
  • Vite
  • Vitest
  • Playwright
  • localize with i18n
  • Typescript with ES6+ syntax
  • Dockerfile

(back to top)

Why Svelte & Tauri

Svelte and Tauri have gained prominence in recent years for their superior performance and reduced memory consumption compared to competitor like Electron. While C# or Swift platforms have the greatest performance and support on Windows and macOS, but cross-platform technologies is more effective especially for frontend developers like me.

This project, being a small to medium-sized multi-platform application, aligns well with the benefits of Svelte and Tauri. In most small-scale projects, Svelte demonstrates better performance than Vue 3. Similarly, Tauri offers a performance advantage over Electron.

By using Svelte and Tauri we can take the following advantages over other cross-platform technologies.

  • Better performance

  • Less memory use

  • Less bundle size

  • More support on modern web development

(back to top)

Runtime Requirement

  • NodeJS LTS 22
  • Rust 1.80
  • WebView 2
  • Microsoft C++ build tools

See Detailed Prerequisites to get more about the dependencies of this project

OS Requirement

  • Windows 10 above (preferable Windows 11 24H2 above)
  • MacOS Big Sur above

(back to top)

How to run this application

Clone this project

$ https://github.com/gaomingzhao666/sweather-widget.git # clone the project
$ cd sweather-widget
$ pnpm install # install dependencies that this project needs
$ pnpm dev # run

Use a Dockerfile to Create a Container

  1. Clone or download this project.
  2. Ensure you have Docker Desktop installed on your computer.
  3. Install the Docker extension in your VScode.
  4. Right-click the Dockerfile in this project and select the Build Image option.
  5. Open Docker Desktop and run the container.

(back to top)

About TDD(Test Driven Development)

This project is my first TDD project, which is used Vitest for Unit Testing and Playwright for Visual or Behavior Component Testing. In contrary and in my opinion, I do not think TDD is so much important in small business just because that could fussing too much time to write testing code especially to small and middle project and personal project or something. But in a scalable project that scaled enough I will likely and prefer to write testing code for this huge project that probably change functionalities in forthcoming future, so I made this project and wrote testing code for it.

(back to top)

Contributor

The project developed by gaomingzhao666@Nano

(back to top)

LICENSE

MIT License

(back to top)