An open API service indexing awesome lists of open source software.

https://github.com/prmntr/teachassist

A TeachAssist app for YRDSB, written in React Native
https://github.com/prmntr/teachassist

app education react-native typescript

Last synced: 5 months ago
JSON representation

A TeachAssist app for YRDSB, written in React Native

Awesome Lists containing this project

README

          



TeachAssist: Check Your Grades


An unofficial mobile app for the YRDSB TeachAssist portal.


Not affiliated with YRDSB or The TeachAssist Foundation!









Download
ยท
Website
ยท
Report Bug
ยท
Request Feature
ยท
Privacy Policy


## Overview

TeachAssist provides students with an open source streamlined mobile experience to access their academic information from the York Region District School Board's TeachAssist portal (ta.yrdsb.ca). View your grades, track performance over time, and get assignment feedback - all in a clean, native mobile interface.

## Features

### Current Features
- ๐Ÿ“Š **Grade Tracking** - View current marks and performance across all classes
- ๐Ÿ“… **Appointment Booking** - Book, view, and cancel guidance appointments directly from the app
- ๐Ÿ”” **Notifications** - Get notified when your marks change and guidance appointments
- ๐Ÿ“ˆ **Trend Analysis** - Track your progress over time with detailed analytics
- ๐Ÿ”ฎ **Performance Prediction** - Add and edit assignments to forecast course performance
- ๐Ÿ“ **Assignment Feedback** - Access teacher feedback on individual assignments
- ๐Ÿ“ฑ **Mobile-Optimized Interface** - Clean, intuitive design built specifically for mobile devices
- ๐Ÿ” **Privacy Features** - End-to-end encryption with YRDSB credentials, plus options to restrict and lock who sees your grades
- โšก **Fast Performance** - Quick access to your academic data

### Coming Soon
- โน๏ธ **Widgets** - See your marks at a glance without ever opening the app
- ๐Ÿง‘โ€๐Ÿ’ป **API** - Interface with the TeachAssist website through code
- ๐ŸŽ **iOS Support** - Support for Apple devices

## Screenshots


TeachAssist: Helping you get ahead
Stay Informed
Stay Intelligent
Stay Ahead
Stay In Touch
Stay Prepared
Stay Private
Stay Private

## Privacy & Security

- **No Data Storage**: Your credentials and academic data stay private between you, your device, and TeachAssist
- **Direct Connection**: The app connects directly to the official YRDSB TeachAssist portal
- **Local Processing**: All data processing happens locally on your device
- **Secure Authentication**: Securely authenticates with the YRDSB portal

## Installation

### For Users
- **Android: [Play Store](https://play.google.com/store/apps/details?id=com.prmntr.teachassist)**
- **Web: [TeachAssist](https://prmntr.com/teachassist)**
- **iOS: [Coming Soon](/)**

### For Developers

#### Prerequisites
- Node.js (v16 or higher)
- npm or yarn
- Expo CLI
- iOS Simulator (for iOS development), Android Studio (for Android development), or an iOS or Android device

#### Setup
1. Clone the repository:
```bash
git clone https://github.com/prmntr/teachassist.git
cd teachassist
```

2. Install dependencies:
```bash
npm install
# or
yarn install
```

3. Start the development server:
```bash
npx expo start
```

4. Run on your preferred platform:
- **iOS**: Press `i` in the terminal or scan the QR code with your iPhone camera
- **Android**: Press `a` in the terminal or scan the QR code with the Expo Go app

## Tech Stack

- **Framework**: React Native
- **Platform**: Expo
- **Language**: JavaScript/TypeScript
- **Authentication**: Secure credential handling for YRDSB portal
- **API Integration**: Custom wrapper for ta.yrdsb.ca

## Contributing

Contributions are welcomed. Here's how you can help:

1. **Fork the repository**
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes**: Implement your feature or fix
4. **Test thoroughly**: Ensure your changes work as expected
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
6. **Push to the branch**: `git push origin feature/amazing-feature`
7. **Open a Pull Request**: Describe your changes and their benefits

## Support

If you encounter any issues or have questions:
- ๐Ÿ› **Bug Reports**: Open an issue on GitHub
- ๐Ÿ’ก **Feature Requests**: Submit an issue with the "enhancement" label
- ๐Ÿ“ง **Contact**: [Google Forms](https://forms.gle/BECBr8LqgtnzzHqS6)

## Disclaimer

**This app is an unofficial mobile client for the YRDSB TeachAssist portal. It is not affiliated with, endorsed by, or officially connected to the York Region District School Board or The TeachAssist Foundation. All academic data is retrieved directly from the official ta.yrdsb.ca portal. I am not responsible for any information displayed on the app. USE THIS APP AT YOUR OWN RISK!**

## License

This project is licensed under the MIT License - see the [LICENCE](LICENCE) file for details.

---

**Made with โ˜•,๐Ÿ“œ & ๐Ÿง‹**