Welcome to Yallyo, a language practice platform designed to connect people worldwide for language exchange and conversation practice. This README provides an overview of the project, its features, and how you can get involved as a contributor.
Yallyo is a web-based platform that allows users to engage in video and voice conversations with others to practice languages. Whether you're learning a new language or looking to improve your language skills, Yallyo provides a space for meaningful interactions with people from around the world.
- Voice Chat: Connect through real-time voice conversations.
- Video Chat: Engage in face-to-face video+voice conversations.
- Text Chat: Send text/emoji/GIF to people in chat rooms.
- No Login Required: choose to login with Google account or create fast temporary account.
- Multi-Language Support: Practice various languages with users of different proficiency levels.
- User-Friendly Interface: Enjoy a seamless experience with a user-friendly interface built with modern technologies.
- Lobby Chat: Chat with others in the lobby area before entering rooms.
- Responsive Design: Yallyo is designed to work on desktop, tablets, and mobile devices.
- Open Source: Yallyo is open-source, which means you can contribute to its development.
To start using Yallyo, you can visit the Yallyo website. There's no need to install an app or create an account. Simply click to join a room and start practicing languages with other people around the world.
The key technologies that we use to make realtime communication over video/voice/text chat possible on Yallyo platform are WebRCT & WebSocket
- NextJS
- Redux Toolkit
- Socket.io Client
- PeerJS (Signaling Server/Wrapper around WebRCT)
- TailwindCSS
- TypeScript
- Vercel (Hosting)
We welcome contributions from the community to help improve and expand Yallyo's features. If you're interested in contributing, please check out our Contribution Guidelines for more information.
Also you can join our dev team on Discord Server as well.
This is a Next.js project bootstrapped with create-next-app, to run locally on your machine please following these steps:
- Clone this project to your local computer and install dependencies
npm install- Create .env.development file with the following variables and place at the root of the project.
(Join our Discord server
Yallyo-Language Exchange Community) and we will provide you the actual Firebase credential values.
NEXT_PUBLIC_API_URL=https://api.dev.heyguyz.com
NEXT_PUBLIC_API_WS_URL=https://api.dev.heyguyz.com
NEXT_PUBLIC_ROOMS_REFRESH=60000
NEXT_PUBLIC_ROOMS_ITEMS=20
NEXT_PUBLIC_CREATE_ROOM_QUOTA=5
#Firebase
NEXT_PUBLIC_FIREBASE_apiKey=
NEXT_PUBLIC_FIREBASE_authDomain=
NEXT_PUBLIC_FIREBASE_projectId=
NEXT_PUBLIC_FIREBASE_storageBucket=
NEXT_PUBLIC_FIREBASE_messagingSenderId=
NEXT_PUBLIC_FIREBASE_appId=
NEXT_PUBLIC_GOOGLE_ANALYTICS_ID=
NEXT_PUBLIC_FACEBOOK_PIXELS_ID=- Run frontend web application by this command
npm run dev- Open http://localhost:65432 with your browser to see the result.
--> It would be even cooler if you guys's avatars also show up here 😃.
This project is licensed under the MIT License - see the LICENSE file for details.