https://github.com/mayank77maruti/phrase-book
https://github.com/mayank77maruti/phrase-book
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mayank77maruti/phrase-book
- Owner: Mayank77maruti
- Created: 2024-10-30T16:41:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T17:29:58.000Z (12 months ago)
- Last Synced: 2024-10-30T18:32:12.849Z (12 months ago)
- Language: TypeScript
- Homepage: https://phrase-book-five.vercel.app
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Multilingual Phrasebook using Tolgee
[
](https://tolgee.io)
## Link
[Live Link](https://phrase-book-five.vercel.app/)
[dev.to](https://dev.to/mayank_mohapatra/phrasebook-with-tolgee-563g)
##
Here i used `tolgee` with `next.js` app router.
based on `next14` app folder with `tolgee` and `next-intl` package.
## Features
Bookmark Feature:
Users can bookmark specific pages for quick access. This feature allows returning to marked phrases instantly. Bookmarked pages will be saved in local storage, enabling persistence even after refreshing or closing the browser. The bookmarked pages can also be displayed in a list view for easy navigation.
Search Functionality:
A built-in search bar allows users to quickly find specific phrases or keywords. As the user types, the app provides instant search results across all phrases and translations in the phrasebook, streamlining navigation within large sets of multilingual content.
Dark Mode and Light Mode:
This make it easy for user to read according to day or night.
Mobile Friendliness:
The layout and UI components are fully responsive, designed to adapt to various screen sizes. Buttons, font sizes, and spacing are optimized for mobile, providing a seamless experience on both smartphones and tablets. Additionally, animations and transitions are performance-optimized to prevent slowdowns on lower-powered devices.
## Setup
1. Clone this repo
2. Run `npm i`
3. Add Gemini Api key in `.env.development.local` file.
4. Run `npm run dev`
## Setup tolgee credentials (optional)
5. Create project in Tolgee platform
6. Add `.env.development.local` file to base folder of this project with an API key to your project
```
NEXT_PUBLIC_TOLGEE_API_URL=https://app.tolgee.io
NEXT_PUBLIC_TOLGEE_API_KEY=
```
7. Re-run `npm run dev`