Skip to content

README_en.md

Latest commit

 

History

History
49 lines (34 loc) · 2.23 KB

README_en.md

File metadata and controls

49 lines (34 loc) · 2.23 KB

Alacrity: Developers' toolbox

GitHub package.json version GitHub Release Date GitHub Downloads (all assets, all releases) GitHub Actions Workflow Status GitHub License

中文

Introduction

My personal project, used to implement some common used development tools, also used to learn relevant technologies.

Features

  1. Plugins suitable for lots of situations, such as Base64, UUID, WebSocket, etc。
  2. Switching between Chinese and English, and change themes between light and dark; when switching theme config to system default, mayby a refresh is needed to activate current theme.

Download & install

You can download installer for Alacrity from GitHub Release page. After installation, double click the shortcut on desktop to use Alacrity.

Local development

Required environments

  1. Node.js, and a package manager, yarn is recommended.
  2. Rust development environment, maybe need to configure a source.

Development process

  1. Clone repository: git clone https://github.com/origin-coding/Alacrity.git
  2. Run yarn install to install dependencies.
  3. Run yarn run tauri dev to run Alacrity for development. Note: Alacrity is configured as a singleton application, which means there is only one application instance at the same time, so you need to close other Alacrity windows during development.
  4. Run yarn run tauri build to build Alacrity.

Powered by

  • Tauri : Frontend cross-platform development framework.
  • Vue and Nuxt : Frontend framework, and uses Nuxt for features like content rendering, auto routing, etc.
  • TDesign : Component library from Tencent.
  • GitHub Actions : Provides CI/CD features like auto building and auto releasing.