new client electron

client-electron/README.md

@@ -0,0 +1,37 @@
+# Taobin Recipe Manager (Electron)
+
+## Development
+
+### Install dependencies
+
+```
+npm install
+```
+
+### Run develop
+
+```
+npm run dev
+```
+
+### Build
+
+Before build, you have to change version in `package.json` to the new version.
+
+```
+npm run build
+```
+
+> note: this will build executable and installer for your current platform
+
+## Environment Variables
+
+We have some environment variables to control app behavior. The environment variables in this project have a prefix `TAOBIN_RECIPE_MANAGER_`. If you want to set environment variables, you have to add this prefix.
+
+> note: All the environment variables can access through `import.meta.env.{VARIABLE_NAME}`.
+
+> note: In development mode, you can create a `.env` file in the root directory of the project to set environment variables.
+
+### TAOBIN_RECIPE_MANAGER_SERVER_URL
+
+- The url of the server. Default: `http://localhost:8080`