https://github.com/midhunterx/gnosis
📖 GNOSIS - For sharing knowledge is an ambitious project designed to transform the way individuals engage with and acquire knowledge.
https://github.com/midhunterx/gnosis
django django-project forum-site gemini-pro knowledge-base python webapp
Last synced: 3 months ago
JSON representation
📖 GNOSIS - For sharing knowledge is an ambitious project designed to transform the way individuals engage with and acquire knowledge.
- Host: GitHub
- URL: https://github.com/midhunterx/gnosis
- Owner: MidHunterX
- Created: 2024-03-18T11:17:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T10:00:06.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T05:28:40.087Z (over 1 year ago)
- Topics: django, django-project, forum-site, gemini-pro, knowledge-base, python, webapp
- Language: HTML
- Homepage:
- Size: 4.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> For sharing knowledge
The "GNOSIS-for sharing knowledge" is an ambitious project designed to transform the way individuals engage with and acquire knowledge in the realm of computer functionality. In today's rapidly evolving technological landscape, the demand for comprehensive and accessible information has never been greater. This platform seeks to bridge the gap between complex technical concepts and userfriendly learning by providing a dynamic and interactive space where users can post questions and receive tailored responses in their preferred format. At its core, the platform is built on the foundation of inclusivity and accessibility, recognizing that users have diverse learning styles and preferences.
# 🆕 Initializing Project
### Step 1: Clone the project
```sh
git clone https://github.com/MidHunterX/GNOSIS
```
### Step 2: Initialize Virtual Environment (Recommended)
Install Python and execute following commands:
```sh
python -m pip install virtualenv
python -m venv ENV
```
### Step 3: Activate Virtual Environment
Using the command based on your current shell
```sh
# CMD
ENV\Scripts\activate.bat
# Powershell
.\ENV\Scripts\Activate.ps1
# Bash and Zsh
source ENV/bin/activate
# Fish
source ENV/bin/activate.fish
```
### Step 4: Install Requirements
```sh
pip install -r requirements.txt
```
### Step 5: Set-up Gemini AI
- Get GeminiAI API Key from 
- Replace the old API key `GOOGLE_API_KEY` inside `.env` file with your New API Key.
### Step 5: Create Admin Account (optional)
```sh
python manage.py createsuperuser
```
# 🏃 Running Project
Execute `runserver.bat` if you are on Windows.
Or run server manually by doing the following steps:
### Step 1: Activate Virtual Environment
Using the command based on your current shell
```sh
# CMD
ENV\Scripts\activate.bat
# Powershell
.\ENV\Scripts\Activate.ps1
# Bash and Zsh
source ENV/bin/activate
# Fish
source ENV/bin/activate.fish
```
### Step 2: Run Server
```sh
python manage.py runserver
```
Open [http://localhost:8000](http://localhost:8000) or [http://127.0.0.1:8000](http://127.0.0.1:8000) with your browser
# 💻 Development Progress
-  Concept of operation
-  Requirements elicitation
-  Database Modelling and Implementation
-  Backend Server Logic Design and Implementation
-  UI/UX Design and Implementation
# 📦 Technologies Used
| Name | Usage |
| -------------------- | ------------------------------------------- |
| Django | Python webapp framework |
| virtualenv | Python package virtual environment |
| python-dotenv | System Environment Variables for Python |
| django-crispy-forms | For all Input Forms |
| crispy-bootstrap5 | Bootstrap for Crispy Forms |
| django-markdownfield | Raw Markdown storage model and renderer |
| bleach | HTML Sanitizier for storing MD to DB |
| Bootstrap v5.3 | CSS Framework |
| Fontawesome | CSS Icons Library |
| easymde | Markdown Editor Frontend for User Input |
| fuzzywuzzy | Fuzzy String Sequence and Pattern detection |
| python-Levenshtein | String similarity and distance operations |
# 🔧 Project Features
## Profile Related Features
- [x] Register an account
- [x] Show error messages on unsuccessful authentication
- [x] Login with registered account on successful authentication
- [x] Edit registered account details
- [x] Upload Pictures to set as Profile Display Picture in account settings
- [x] Logout of registered account
- [x] View own registered account
- [x] View other registered accounts
- [x] Upload Pictures for Profile Picture
- [x] Toggle between Uploader and Viewer Mode
## Question Related Features
- [x] Create questions in plaintext
- [x] Read questions
- [x] Update questions in plaintext
- [x] Delete questions
- [x] Add questions to favorites list
- [x] Optional ability to restrict comments on study materials / posts
- [x] Auto Generate answers with Gemini AI
- [x] Answer questions asked by other registered accounts in plaintext
- [x] Answer questions asked by other registered accounts in markdown
- [x] Sanitize problematic HTML tags for security
- [x] Model in Database for storing Sanitized Data
- [x] Renderer for stored markdown code
- [x] Answer questions asked by other registered accounts with inline image (url) attachment
- [x] Answer questions asked by other registered accounts in audio
- [x] Answer questions asked by other registered accounts in video
## User Interface Features
- [x] Switch between Light mode and Dark mode
- [x] Fully featured markdown input formatting UI
- [x] Query questions using fuzzy logic
- [x] Generative AI Answer and Fuzzy Search questions logic using a single search bar
- [x] Show Generating Status on Answer Generation
- [x] Split Uploader/Viewer mode selection screen
- [x] Dropdown list for all Profile Functions
- [x] Show a landing page on website load
- [x] Searched question's multimedia answer query options (more option)
## Optional Features
- [x] Show a welcome page after login
- [x] Show a goodbye page after logout
- [x] On goodbye page, redirect users to login page after n seconds
- [x] Human readable approximate timestamps
## TODO List
- [x] Illustration for Hero Section
- [x] Landing Page Feature List
- [x] Attach answer UI within Ask Question form for Uploaders
- [ ] Tab style multimedia uploading form
# ⚠️ Problems Faced
### Question Search Logic
Task: Search for an input question in a database. If question found, return question; else, return generated answer.
- Searching for questions based on string comparison won't work on spelling mistakes and rephrased questions
- Spelling mistakes issue can be solved using Levenshtein distance which finds the similarity of two strings
- With that set, the rest of the input can be compared using Fuzzy Logic which returns questions similar enough
- So, the best approach is to use Fuzzy Logic based on string similarity percentage.
- If similarity percentage is set high, it might skip slightly rephrased questions.
- If similarity percentage is set low, wrong questions with similar words might be returned.
# ✂️ Snippets for Development
### Re-applying Migrations (Col not found error)
```sh
python manage.py migrate gnosis_app zero
python manage.py migrate
```