Skip to content

Lexishift is a dyslexia-friendly PDF converter designed to enhance accessibility for individuals with dyslexia. This web-based tool allows users to upload PDF files and convert them into dyslexia-friendly formats with customizable text and layout options.

License

Notifications You must be signed in to change notification settings

sanks011/Lexishift

Repository files navigation

Lexishift 🌟

Lexishift is a dyslexia-friendly PDF converter designed to enhance accessibility for individuals with dyslexia. This web-based tool allows users to upload PDF files and convert them into dyslexia-friendly formats with customizable text and layout options. 📄✨

Features

  • Upload PDFs: Easily upload PDF documents for conversion. 📥
  • Customizable Formatting: Adjust font type, size, line spacing, letter spacing, and text color to suit individual preferences. 🎨🔤
  • OCR Technology: Utilizes Optical Character Recognition (OCR) to extract and convert text from PDF files. 🔍📜
  • User Feedback: Collect and incorporate user feedback to improve dyslexia-friendly formatting suggestions over time. 📝👍
  • Machine Learning: Uses a machine learning model to predict and suggest optimal formatting based on user preferences. 🤖📊

Installation 🛠️

To run Lexishift locally, follow these steps:

1. Clone the Repository:

git clone https://github.com/sanks011/Lexishift.git

2. Navigate to the Project Directory:

cd Lexishift

3. Install Dependencies:

Ensure you have pip installed, then install the required packages:

pip install -r requirements.txt

4. Set Up Environment Variables:

Create a .env file in the project root and add any necessary environment variables. For example:

SECRET_KEY=your_secret_key

5. Run the Application:

Start the Flask development server:

python app.py

The application will be accessible at http://127.0.0.1:5000/. 🌐

Usage 💻

  • Upload a PDF: Use the upload form to select and upload a PDF file. 📂

  • Customize Formatting: Adjust the formatting options as desired. 🎨

  • Convert: Click the convert button to generate a dyslexia-friendly PDF. 🔄

  • Download and Provide Feedback: Download the converted PDF and provide feedback on the formatting. 📥📝

Authors 👥

Contributing 🤝

Contributions are welcome! If you would like to contribute to Lexishift, please follow these steps:

1. Fork the repository. 🍴
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request. 🔄

License 📝

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

Contact 📫

For any questions or support, feel free to reach out:

About

Lexishift is a dyslexia-friendly PDF converter designed to enhance accessibility for individuals with dyslexia. This web-based tool allows users to upload PDF files and convert them into dyslexia-friendly formats with customizable text and layout options.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published