iLearn is a collaborative platform where users can create groups, share resources, and exchange notes effortlessly.
- User Groups: Create and manage groups for sharing resources.
- Resource Sharing: Upload and share notes and PDFs easily.
- PDF Processing: Process PDFs for reading and managing content.
- Responsive Design: Built with Bootstrap 5 for mobile-friendly UI.
- Interactive UI: Powered by jQuery for dynamic user interaction.
Follow these steps to set up the project locally:
-
Clone the repository:
git clone https://github.com/himaldahal/iLearn.git cd iLearn
-
Set up a virtual environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Apply migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Access the application: Open your browser and go to http://127.0.0.1:8000.
- Register or log in.
- Create a group or join an existing one.
- Upload and share notes and resources with your group.
- Process and read PDFs directly within the application.
- Frontend:
- Bootstrap 5
- Bootstrap Icons
- jQuery
- Backend:
- Django (Python)
- PDF Processing:
- PyPDF2
iLearn/
├── myauth/ # Authentication module
├── reader/ # PDF reader and processing module
├── templates/ # HTML templates
├── manage.py # Django management script
├── requirements.txt # Python dependencies
├── db.sqlite3 # database
Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Commit your changes.
- Push your branch and open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.