A beautiful, client-side React application for practicing Japanese conversation with an AI friend using the Together AI Llama model.
- Real-time Chat: Practice Japanese with AI responses in Japanese and English translations
- Beautiful UI: Modern Material-UI design with responsive layout
- Suggested Starters: Pre-built conversation starters in Japanese
- Rate Limit Handling: Graceful error handling for API limits
- Client-side Only: No backend required, runs entirely in the browser
- Node.js (version 16 or higher)
- npm or yarn
- A Together AI account with API access
-
Clone the repository
git clone https://github.com/crizmo/tomodachi.git cd tomodachi
-
Install dependencies
npm install
-
Get your Together AI API key
- Go to Together AI
- Sign up for an account
- Navigate to your dashboard
- Generate an API key
Note: The free tier has rate limits (600 requests per minute). For higher limits, consider upgrading your account.
-
Start the development server
npm run dev
-
Open your browser
Navigate to
http://localhost:5173
(or the port shown in your terminal)
- Set up your API key: Click the settings icon (⚙️) in the top-right corner and enter your Together AI API key
- Start a conversation: Click on any suggested starter or type your own message
- Practice Japanese: The AI will respond in Japanese with English translations
- Clear chat: Use the clear button to start a new conversation
- Rate limits: If you hit the limit, wait a moment before continuing
- こんにちは (Hello)
- 元気ですか? (How are you?)
- 今日は何をしましたか? (What did you do today?)
- And more...
npm run build
The built files will be in the dist
directory. You can deploy them to any static hosting service like Vercel, Netlify, or GitHub Pages.
- Linting:
npm run lint
- Preview production build:
npm run preview
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
- Together AI for the Llama model API
- Material-UI for the beautiful UI components
- Vite for the fast build tool
If you have any questions or issues, please open an issue on GitHub or contact the maintainers.
Enjoy practicing Japanese with Tomodachi! 🇯🇵