Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md #45

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Tauri UI Template is a starting point for building modern desktop applications w
## Getting Started

```
gh repo clone agmmnn/tauri-ui
cd tauri-ui
gh repo clone GHGHGHKO/dalgona
cd dalgona
pnpm i
```

Expand All @@ -36,29 +36,35 @@ pnpm tauri dev
pnpm tauri build
```

![tauri-ui](https://user-images.githubusercontent.com/16024979/232823230-19d22434-8e28-43c2-bb70-e45a2fc2da88.gif)
### Set environments
TENOR : `TENOR_API_KEY`
GIPHY : `GIPHY_API_KEY`

## Customization
**PowerShell**
```shell
[Environment]::SetEnvironmentVariable(TENOR_API_KEY, "Insert your Tenor Key", "User")
```

**macOS**
```shell
launchctl setenv TENOR_API_KEY "Insert your Tenor Key"
```

The template can be customized by editing the following files:

- [src-tauri/tauri.conf.json](src-tauri/tauri.conf.json)
- [package.json](/package.json)
- [src-tauri/cargo.toml](src-tauri/Cargo.toml)
- To change the app icon, update `app-icon.png`, and then run `pnpm tauri icon`. This will automatically generate icon files into _src-tauri/icons_.
## Wiki
https://github.com/GHGHGHKO/dalgona/wiki

## Update Components

Note that **shadcn/ui** [is not a library](https://ui.shadcn.com/docs#faqs), therefore you will need to update the components manually. To do so, you can [download](https://download-directory.github.io/?url=https%3A%2F%2Fgit.luolix.top%2Fshadcn%2Fui%2Ftree%2Fmain%2Fapps%2Fwww%2Fcomponents%2Fui) the _[shadcn/ui/apps/www/components/ui](https://github.com/shadcn/ui/tree/main/apps/www/components/ui)_ directory and paste it into _[src/components/ui](/src/components/ui)_.

## To-Do

- [x] Titlebar draggable.
- [x] Titlebar minimize, maximize, close buttons.
- [x] Titlebar double-click maximize.
- [x] Decomposing UI into components.
- [x] Dark-Light mode switch.
- [x] Get simple data from the Rust backend code.
- [x] TENOR API
- [x] GIPHY API
- [ ] IMGUR API
- [ ] Gfycat API
- [ ] Updater

## Folder Structure

Expand Down Expand Up @@ -93,4 +99,4 @@ Note that **shadcn/ui** [is not a library](https://ui.shadcn.com/docs#faqs), the

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- [VS Code](https://code.visualstudio.com/) or [Jetbrains IntelliJ](https://www.jetbrains.com/ko-kr/idea/download/?section=windows) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)