https://github.com/ppmpreetham/vfriend
👩🏻🤝👨🏻A Cross-platform app written in tauri for VIT Students to check which of your friends are free right now
https://github.com/ppmpreetham/vfriend
tauri tauri-app tauri-apps vit vitchennai
Last synced: 11 months ago
JSON representation
👩🏻🤝👨🏻A Cross-platform app written in tauri for VIT Students to check which of your friends are free right now
- Host: GitHub
- URL: https://github.com/ppmpreetham/vfriend
- Owner: ppmpreetham
- License: mit
- Created: 2024-08-15T11:48:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-19T14:57:19.000Z (11 months ago)
- Last Synced: 2025-07-19T16:13:31.182Z (11 months ago)
- Topics: tauri, tauri-app, tauri-apps, vit, vitchennai
- Language: TypeScript
- Homepage:
- Size: 3.25 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Check status of your friends at any time
Download the App
> [!WARNING]
> This app is still in development, and is not yet ready for production use. There are many features that are still missing, and there may be bugs. Please use it at your own risk.
## Why VFriend?
An year ago, while I was a freshman at my college, I had an oddly specific problem of having a little too many friends. Oftentimes, I’d often find myself digging through old WhatsApp/Discord chats, trying to find the timetables they had sent me, one by one, over and over. It was tedious, repetitive, and honestly, a little ridiculous. I kept thinking, there has to be a better way to do this. But back then, I didn’t know much about app development. I had spent time learning web dev, but even now, as I write this, you could say, this is my first real app.
## Usage
0. **Install Node.js**: Make sure you have Node.js installed on your system. You can download it from [nodejs.org](https://nodejs.org/).
1. **Install pnpm**: If you haven't already, install `pnpm` globally
```bash
npm install -g pnpm
```
2. **Install Rust**: Make sure you have Rust installed on your system. You can download it from [rustup.rs](https://rustup.rs/).
3. **Install Tauri CLI**: Install the Tauri CLI globally using `pnpm`:
```bash
pnpm install -g @tauri-apps/cli
```
4. **Install Tauri**: Follow the [Tauri installation guide](https://tauri.app/v2/getting-started/prerequisites/) to set up your environment.
5. **Clone the Repository**:
```bash
git clone https://github.com/ppmpreetham/vfriend.git
cd vfriend
```
6. **Install Dependencies**:
```bash
pnpm i
```
7. **Change the IP**:
Open `src-tauri/tauri.conf.json` and change the `devPath` to your IP address. For example:
```json
"devPath": "http://172.22.198.42:1420/"
```
8. **Run the App**:
```bash
pnpm tauri dev
```
9. **Build the App**:
```bash
pnpm tauri android build -- --apk
```
### Android
To build the app for Android, you need to have the Android SDK and NDK installed. Follow the [Tauri Android guide](https://tauri.app/v2/guides/mobile/android/) for detailed instructions.
0. Add this to `.vscode/settings.json` to ignore Tauri's Android schema:
```json
"yaml.schemaStore.enable": false
```
1. First, initialize the Android project:
```bash
pnpm tauri android init
```
2. Copy the `android/AndroidManifest.xml` by removing `gen/android/app/src/main/AndroidManifest.xml`:
```bash
cp src-tauri/gen/android/app/src/main/AndroidManifest.xml src-tauri/gen/android/app/src/main/AndroidManifest.xml
```
3. Copy the `android/build.gradle.kts` by removing `gen/android/app/build.gradle.kts`:
```bash
cp src-tauri/gen/android/build.gradle.kts src-tauri/gen/android/app/build.gradle.kts
```
4. Change the theme in `src-tauri/gen/android/app/src/main/res/values/themes.xml` for theme
5. Then, build the app for Android:
```bash
pnpm tauri android build
```
## TO-DO
- [x] Seperate stores for oneSelf and friends
- [x] Remove redundant and unused Hooks
- [x] Add support for [Deep-Links](https://v2.tauri.app/plugin/deep-linking/#setting-up) on Mobile(Android and IOS)
- [x] Better addFriend functionality
- [x] Setup Permissions for fs, Dialog for Mobile(Android and IOS)
- [x] Fix Dialog for Android (currently gives content://com.android.providers.media.documents/document/document%3A1000313997)
- [x] Friend page Search functionality
- [x] Friend individual page
- [x] Settings page
- [x] QR Code functionality
- [x] Share link to add friend functionality
- [x] Ability to change the time format
- [x] Multiple themes
- [x] Deep-Link onClick functionality
- [ ] GitHub Actions Automation
- [ ]
- [ ] useNavigation for back button, refer to https://github.com/tauri-apps/tauri/issues/8142
- [ ] Add Friend via Deep-Link
- [ ] Update Self Timetable
- [ ] Update Friend Timetable
- [ ] peer-to-peer functionality
- [ ] NFC Functionality (optional)
- [ ] Calendar page