Skip to content

afnanahmadtariq/Agen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agen

Agen is a web application designed to help students generate assignments quickly and efficiently. This repository contains the frontend code built with Flutter, while the backend functionalities are implemented using Azure Functions with Python and user authentication and data storage are managed using Firebase.

Getting Started

To get started with the Agen web application, follow these steps:

Download APK

You can download the latest version of the APK for Android devices from the following link:

Download APK

Please note that this APK may be automatically generated by our CI/CD pipeline and may contain the latest changes merged into the main branch. If you encounter any issues or bugs, please let us know by submitting an issue.

For latest Stable

or you can...

  1. Clone the Repository: Clone this repository to your local machine.

    git clone https://github.com/afnanahmadtariq/Agen.git
    
  2. Ensure that you have Flutter installed on your machine. If not, install Flutter.

  3. Open the project directory in your terminal or command prompt.

  4. Run flutter pub get to install dependencies.

  5. Connect an Android device or emulator.

  6. Run the Application: Run the Flutter application on your preferred emulator or physical device.

flutter run

Features

  • User Authentication: Students can create an account or log in using Firebase Authentication.
  • Assignment Generation: Generate assignments based on selected templates and input questions.
  • Keyword Extraction: Extract keywords from user-entered questions using Python RAKE package.
  • Data Retrieval: Fetch relevant information from the web using web scraping techniques.
  • Data Processing: Clean, tokenize, and normalize retrieved data.
  • Relevance Checking: Use Word2Vec to check the relevance of retrieved data to the query.
  • Assignment Templates: Choose from predefined assignment templates including Easy, Medium, Complex, and Blank.
  • Download Options: Download generated assignments in PDF or Docx format.
  • Application Guide: Provide a guide to users on how to use the application effectively.

Technologies Used

  • Flutter: Frontend development framework for building cross-platform applications.
  • Azure Functions: Serverless compute service for running event-triggered code.
  • Python: Programming language used for backend logic and data processing.
  • Firebase: Backend-as-a-Service (BaaS) platform for user authentication and data storage.
  • RAKE (Rapid Automatic Keyword Extraction): Python package for keyword extraction.
  • WordNet: Lexical database for the English language used for semantic analysis.
  • Beautiful Soup: Python library for web scraping.
  • Page Ranker: Library or algorithm used for ranking fetched URLs.
  • Word2Vec: Neural network model used for semantic analysis and relevance checking.

Contributing

Contributions are welcome! If you'd like to contribute to the Agen project, please follow these guidelines:

  1. Fork the repository and create your branch (git checkout -b feature/your-feature).
  2. Commit your changes (git commit -am 'Add some feature').
  3. Push to the branch (git push origin feature/your-feature).
  4. Create a new Pull Request and describe your changes in detail.

License

This project is licensed under the MIT License.

Acknowledgements

  • Flutter Documentation
  • Azure Functions Documentation
  • Firebase Documentation
  • RAKE GitHub Repository
  • WordNet Documentation
  • Beautiful Soup Documentation
  • Page Ranker Algorithm
  • Word2Vec Documentation