Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions Team 143-Dyslexia reading tool/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# env files (can opt-in for committing if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
43 changes: 43 additions & 0 deletions Team 143-Dyslexia reading tool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Readify - Dyslexia-Friendly Reading Tool

Readify is an AI-powered web application designed to make reading more accessible and enjoyable for individuals with dyslexia. By providing dyslexia-friendly formats, text-to-speech capabilities, and AI-driven text refinement, this tool ensures a comfortable and inclusive reading experience.

"Read Better. Live Brighter. For Dyslexia."

## Features

- **Dyslexia-Friendly Formats**: Converts standard text into readable, dyslexia-friendly fonts and layouts.
- **PDF Upload & Processing**: Seamlessly upload PDF documents to extract and adapt text.
- **Text-to-Speech (TTS)**: Integrated with Google TTS API to read text out loud.
- **AI Text Refinement**: Utilizes OpenAI to simplify or adjust complex text for better comprehension.
- **Modern Interface**: Built with Next.js, Tailwind CSS, and Radix UI primitives for a highly accessible, responsive, and beautiful user experience.

## Tech Stack

- **Frontend**: [Next.js 15](https://nextjs.org/) (App Router), React 19, Tailwind CSS
- **UI Components**: [Radix UI](https://www.radix-ui.com/) (configured via `shadcn/ui` style patterns)
- **Integrations**: `openai`, `google-tts-api`, `pdf-parse`, `pdfjs-dist`

## Getting Started

First, ensure you have your environment variables set up (e.g., your OpenAPI key for AI text processing).

Then, install dependencies and run the development server:

```bash
npm install
npm run dev
# or use yarn / pnpm / bun
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Usage
1. Navigate to the landing page at `/`.
2. Click **Go** to proceed to the document tools.
3. Upload a document (PDF) or interact with the text.
4. View the refined text in a dyslexia-friendly format and use the text-to-speech controls as needed.

## Contributing

Contributions are welcome! If you have suggestions or want to improve the tool, please fork the repository and create a pull request.
21 changes: 21 additions & 0 deletions Team 143-Dyslexia reading tool/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "new-york",
"rsc": true,
"tsx": true,
"tailwind": {
"config": "",
"css": "src/app/globals.css",
"baseColor": "neutral",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"iconLibrary": "lucide"
}
7 changes: 7 additions & 0 deletions Team 143-Dyslexia reading tool/next.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { NextConfig } from "next";

const nextConfig: NextConfig = {
serverExternalPackages: ["pdf-parse"],
};

export default nextConfig;
Loading