Boilermate is an educational app designed to bridge the gap between theoretical content and its practical application in advanced courses at Purdue University. It offers personalized features tailored to Purdue students, aiming to enhance their learning experience and academic success.
- Account Creation: Create a personalized account to tailor your learning experience based on your major, class standing, and enrolled courses.
- Real-Time Content Review: Scrapes content from Purdue's course websites to provide an up-to-date review of topics being taught in your classes.
- Advanced Recommendation Algorithm: Recommends relevant resources such as websites and videos based on a user-user algorithm, user interactivity metrics and class curriculum.
- User Retention Mechanics: Encourages daily engagement through streaks, rewards, and incentives, fostering a habit of consistent learning.
To get started with Boilermate, follow these steps:
- Clone the repository to your local machine.
- Install dependencies for the frontend using
npm install. - Cd to the
clientfolder. - Start the development server using
npm start. - Cd to the
backendfolder. - Install dependencies for the backend using
pip install requirements.txt - Start the middleman API using
python3 manage.py runserver. - Explore the app and its features!
For more information on the app, please find the User Docs.
Contributions are welcome! If you'd like to contribute to Boilermate, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure all tests pass.
- Submit a pull request detailing your changes.
Contributions and derivative work are encouraged to be open-source to benefit the community.
This project is licensed under the MIT License - see the LICENSE file for details.
- Purdue University for providing the inspiration and resources for this project.
- React Native for the framework used to develop the mobile app.
- Firebase for providing the backend infrastructure.
- Python: Django for providing assistance for api development.