translator-tamagui / README.md
huuquyet's picture
Update README.md
a40ab14 verified
|
raw
history blame
No virus
2.35 kB
---
title: Translator Tamagui
emoji: πŸ’»
colorFrom: green
colorTo: red
sdk: static
pinned: true
license: wtfpl
models:
- Xenova/nllb-200-distilled-600M
- huuquyet/vinai-translate-vi2en-v2
- huuquyet/vinai-translate-en2vi-v2
short_description: Translator demo App built with Transformers.js + Tamagui
---
# Translator demo App built with Transformers.js + Tamagui + Next.js
## πŸ”¦ About
This Translator app is a starter for a Transformers.js + Tamagui + Next.js
Please check out the demo site
[![Open in Spaces](https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm-dark.svg)](https://huggingface.co/spaces/huuquyet/translator-tamagui)
or [Vercel app](https://translator-tamagui.vercel.app/).
## πŸ“¦ Included packages
- Transformers.js
- Tamagui πŸͺ„
- Next.js
## πŸ—‚ Folder layout
The main apps are:
- `src` all the components and screens
## 🏁 Start the app
1. Clone the repo and install dependencies:
```bash
git clone https://github.com/huuquyet/translator-tamagui.git
cd translator-tamagui
yarn install
```
2. Run the development server:
```bash
yarn dev
```
> Firefox users need to change the `dom.workers.modules.enabled` setting in `about:config` to `true` to enable Web Workers.
> Check out [this issue](https://github.com/xenova/whisper-web/issues/8) for more details.
3. Open the link (e.g., [http://localhost:3000/](http://localhost:3000/)) in your browser.
## πŸ†• Add new dependencies
### Pure JS dependencies
If you're installing a JavaScript-only dependency that will be used across platforms, install it :
```sh
yarn add zustand
```
## Update new dependencies
### Pure JS dependencies
```sh
yarn upgrade-interactive
```
You may potentially want to have the native module transpiled for the next app. If you get error messages with `Cannot use import statement outside a module`, you may need to use `transpilePackages` in your `next.config.js` and add the module to the array there.
## Deploying to Vercel
- Install vercel cli (if not): `npm i -g vercel`
- Login to vercel: `vercel login`
- Build command to be `vercel build` (add `--prod` if wanna build production version)
- Build command: leave default setting
- Output dir: leave default setting
- Deploy to vercel: `vercel --prebuilt` (add `--prod` if wanna deploy to production)