https://github.com/crystallizeapi/translation-app
https://github.com/crystallizeapi/translation-app
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/crystallizeapi/translation-app
- Owner: CrystallizeAPI
- Created: 2023-09-05T09:09:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T18:03:49.000Z (about 1 year ago)
- Last Synced: 2025-01-20T17:24:01.652Z (5 months ago)
- Language: TypeScript
- Homepage: https://translation-app-three.vercel.app
- Size: 1.24 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Crystallize Translation App
This is the Crystallize Translation App to be injected like a Custom View
## Requirements
A Crystallize App injects a signature to notify the current tenant and it requires HTTPS.
Therefore, even locally, you need HTTPS.
You need:
- Caddy Server
- Node 20
- PNPM
Also you need `translation-app.crystallize.app.local` to point to `127.0.0.1`
When you are all set you can install the app for development.
## Install
Create the `.env` file from the `.env.dist` file.
```bash
cp .env.dist .env
```
> `.env` is in the `.gitignore` on purpose, you don't want to commit that secret file.
Then open the `.env` and update the values.
Then you can
```bash
make install
```
This will install the dependencies.
## Run the project
```bash
make serve
```
Please not that won't following URL won't work directly in your browser like an usual project. It expects a signature from Crystallize to set up the Cookie and other parameters to setup the context.
So you can go ahead in your Crystallize Tenant Settings > Build > Custom Views
Add a Custom View and input this string:
`https://translation-app.crystallize.app.local/?itemId={{itemId}}&fromLanguage={{language}}&variantId={{variantId}}`
## Hosting
This project is running with Remix Run 2.1 and there you can host it almost anywhere