PeerPrep is an innovative collaborative learning platform that connects students across the globe for peer-to-peer study sessions, resource sharing, and progress tracking.
Our mission is to empower learners to achieve their academic goals through community-driven learning. 🤝
- Collaborative Learning – Connect with peers worldwide for effective study sessions.
- Structured Content – Access curated learning materials and practice problems.
- Goal Tracking – Monitor your progress with analytics and insights.
- Live Chat – Get instant support from peers or mentors.
- Planned Features:
- AI-powered study partner matching
- Gamification with badges and leaderboards
- Integration with popular note-taking tools
- Frontend: HTML5, CSS3, JavaScript (vanilla)
- Backend: Django 4.x (Python 3.12)
- Database: SQLite (default)
- Environment: Virtualenv
- Other: Responsive design, smooth animations, MIT License
PeerPrep/
├── core/ # Main application logic (Django core configs)
├── peerprep/ # Project-specific app (settings, URLs, WSGI, ASGI)
├── static/ # Static files (CSS, JS, Images)
├── templates/ # HTML templates for frontend
├── venv/ # Virtual environment (should be excluded in .gitignore)
│
├── db.sqlite3 # SQLite database (default for dev)
├── manage.py # Django project management script
│
├── .gitignore # Git ignore rules
├── CODE_OF_CONDUCT.md # Contributor code of conduct
├── LICENSE # Project license
├── README.md # Project documentation
├── requirements.txt # Python dependencies
Follow these steps to get the project up and running locally:
- Clone the Repository
git clone https://github.com/yourusername/peerprep.git
cd peerprep- Create a Virtual Environment
python3 -m venv venv
source venv/bin/activate # macOS/Linux
venv\Scripts\activate # Windows- Install Dependencies
pip install -r requirements.txt- Apply Migrations
python manage.py migrate- Run the Development Server
python manage.py runserverVisit http://127.0.0.1:8000 in your browser to start using PeerPrep. 🚀.
We welcome contributions from everyone! 🙌
Steps to contribute:
- Fork the repository
- Create a new branch (git checkout -b feature-name)
- Make your changes and commit (git commit -m "Add feature")
- Push to your branch (git push origin feature-name)
- Open a Pull Request
Please follow our Code of Conduct to ensure a safe and respectful environment. Please read our Code of Conduct to ensure a positive and respectful community.
This project is licensed under the MIT License – see the LICENSE file for details.
🙌 Thank You, Contributors!
Thank you once again to all our contributors! Your efforts are truly appreciated. 💖👏
If you like this project, consider giving it a ⭐ and sharing it with friends!
Maintained with ❤️ by the radhika-droid/PeerPrep