Skip to content

Noter is a notes taking web based application with feature of making notes public and notes summerization. This project was my bachelor mini project and I am extending it.

Notifications You must be signed in to change notification settings

SuhelKhanCA/Noter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Noter - Documentation

Project Overview

SuhelKhanCA Noter is a web-based note management application that allows users to create, edit, summarize, generate, and manage notes. It supports public and private notes, user authentication, admin features, and integration with OpenAI APIs for automatic note generation and summarization.


Directory Structure

suhelkhanca-noter/
├── css # for css old
├── img # for img old
├── js # for js old
├── old-php # for old-php code
├── pythonize # main django directory


Features

User Features

  • Create Notes: Add new notes with a title and description.
  • Edit Notes: Modify existing notes.
  • Public/Private Notes: Set notes to public or private.
  • Summarize Notes: Use AI to summarize long notes.
  • Generate Notes: Use AI to generate notes based on input.
  • View Notes: Access public notes or personal private notes.

Admin Features

  • Manage all public and private notes.
  • View detailed information about notes and users.
  • Permanently or temporarily delete users.
  • Undo specific actions, like making a note private.

AI Integration

  • Summarization: Summarizes lengthy notes for quick reference.
  • Note Generation: Generates notes automatically using the OpenAI API.

Authentication

  • User login and registration system.
  • Secure logout functionality.

Technologies Used

Frontend

  • HTML5 and CSS3 for the structure and styling.
  • Materialize CSS for responsive design and pre-styled components.
  • JavaScript for interactivity and dynamic functionality.

Backend

  • PHP for server-side logic.
  • MySQL for database management.

AI Integration

  • OpenAI API for note generation and summarization.

Development Environment

  • XAMPP on Windows for local server and database setup.

Installation and Setup

Steps to Run

  1. Clone the Repository:
git clone [https://github.com/SuhelKhanCA/suhelkhanca-noter.git](https://github.com/SuhelKhanCA/suhelkhanca-noter.git)

Usage

  • Register: Sign up to create an account.
  • Login: Use your credentials to access the dashboard.
  • Create Notes: Add a note using the provided form.
  • Summarize or Generate Notes: Use the AI features to enhance your note management.
  • Admin: If logged in as admin, manage notes and users from the admin dashboard.

Screenshots

Include screenshots of:

  • Dashboard
  • Create Note Page
  • AI Features (Summarize & Generate)
  • Admin Panel

(You can add your snapshots here for better documentation.)

Future Enhancements

  • Add a search bar for quick note lookup.
  • Implement user roles for better access control.
  • Include note categories for better organization.
  • Integrate email notifications for reminders.

Contact

Developed by Suhel Khan.

GitHub: SuhelKhanCA

Snapshots

Index

image

Footer

image

Motivation and User manual info

image image

Login Page

image

Register

image

Notes Page

image

Create Note

image

Public notes

image

View Notes

image

Admin Modules

View Notes

image

Notes Info

image

Removed user

image

About

Noter is a notes taking web based application with feature of making notes public and notes summerization. This project was my bachelor mini project and I am extending it.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published