iLearn

iLearn is a collaborative platform where users can create groups, share resources, and exchange notes effortlessly.

Table of Contents

• Features
• Installation
• Usage
• Technologies Used
• Project Structure
• Contributing
• License

Features

• 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.

Installation

Follow these steps to set up the project locally:

1. Clone the repository:

   git clone https://github.com/himaldahal/iLearn.git
   cd iLearn
   

2. Set up a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`
   

3. Install dependencies:

   pip install -r requirements.txt
   

4. Apply migrations:

   python manage.py migrate
   

5. Run the development server:

   python manage.py runserver
   

6. Access the application: Open your browser and go to http://127.0.0.1:8000.

Usage

1. Register or log in.
2. Create a group or join an existing one.
3. Upload and share notes and resources with your group.
4. Process and read PDFs directly within the application.

Technologies Used

• Frontend:
  • Bootstrap 5
  • Bootstrap Icons
  • jQuery
• Backend:
  • Django (Python)
• PDF Processing:
  • PyPDF2

Project Structure

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

Screenshots

Homepage

Projects Page

PDF Reader

Register Page

Sign-in Page

Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request.

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes.
4. Push your branch and open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.