Yar (Persian for "helper" or "friend") is a web application designed to connect patients in need of companionship with volunteers who are willing to help. This platform aims to reduce loneliness and provide support for individuals during difficult times.
- User Roles: Three distinct user types:
- Patients: Can request companionship.
- Healthcare Professionals: Can request companionship on behalf of their patients.
- Companions (Yar): Volunteers who can accept requests.
- Request System: A simple interface for creating and managing companionship requests.
- Bilingual Support: Fully supports both English and Persian (فارسی) with a one-click language switcher.
- Secure Authentication: User registration and login handled securely via Supabase.
- Frontend: React (with Vite)
- Backend & Database: Supabase
- Styling: Tailwind CSS
- Internationalization (i18n): react-i18next
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
-
Clone the repository:
git clone https://github.com/theMahdiyarB/yar.git cd yar -
Install NPM packages:
npm install
-
Set up your environment variables:
- Create a new file in the root of your project named
.env. - Copy the contents of
.env.example(if you have one) or add the following lines:
VITE_SUPABASE_URL=YOUR_SUPABASE_URL VITE_SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY
- Replace
YOUR_SUPABASE_URLandYOUR_SUPABASE_ANON_KEYwith your actual credentials from your Supabase project dashboard (Settings > API).
- Create a new file in the root of your project named
-
Run the development server:
npm run dev
The application should now be running on http://localhost:5173.
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
This project is licensed under the MIT License. See the LICENSE file for details.
Mahdiyar B - theMahdiyarB