Dyslexia/Dyscalculia Translator

This project aims to assist individuals with dyslexia and dyscalculia by breaking down questions into more understandable components.

---

Table of Contents

1. Overview
2. Setup Instructions
   • Prerequisites
   • Installation Steps
3. Usage
4. Contributing
5. License

---

Overview

The Dyslexia/Dyscalculia Translator simplifies complex questions, providing a more accessible and supportive user experience for individuals with dyslexia and dyscalculia. By leveraging OpenAI's API, this project aims to promote inclusivity and equal access to information.

---

Setup Instructions

Prerequisites

Before setting up, ensure the following are installed on your system:

• Node.js
• npm
• zsh (optional, for running zsh commands)

Installation Steps

1. Clone the Repository
   Clone the project repository to your local machine.

2. Install Dependencies
   Navigate to the frontend and server directories separately and install the required dependencies:

   cd frontend
   npm install
   cd ../server
   npm install
   

3. Setup OPEN AI Key Add your OpenAI API key to the index.js file located in the server directory.

4. Install Nodemon Globally Ensure nodemon is installed globally to simplify server management:

    npm install -g nodemon
   

5. Start the server Navigate to the server directory and run the server:

    cd server
    nodemon index.js
   

6. Start the frontend Navigate to the frontend directory and run the development server:

    cd ../frontend
    npm run dev
   

Usage

1. Launch the server and frontend as outlined in the setup instructions.
2. Open the provided link in your browser.
3. Enter questions or statements to be translated into a more understandable format.
4. Interact with the interface to receive simplified text, tailored for individuals with dyslexia and dyscalculia.

---

Contributing

We welcome contributions to improve this project! To contribute:

1. Fork the repository.
2. Create a new branch (feature/your-feature-name).
3. Commit your changes and push the branch to your forked repository.
4. Submit a pull request for review.

---

License

This project is licensed under the MIT License.

Feel free to adapt, modify, and use the project in your own applications while adhering to the license terms.