Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 2.63 KB

README.md

File metadata and controls

115 lines (79 loc) · 2.63 KB
Raw

Tech4All

Project Description

Tech4All is a forward-thinking project that aims to promote inclusivity in the digital world by creating tech solutions accessible to differently-abled individuals. Our mission is to ensure full participation and empowerment through inclusive design and technology.

Key Features

  • PDF to Speech: Integrates Google Cloud AI API to convert PDF documents to spoken word, making textual information accessible to visually impaired users.
  • E-Learning Platform: A robust backend to support an inclusive e-learning platform, allowing users of all abilities to access educational content. image

c

Tech Stack

Frontend:

  • Next.js with TailwindCSS

Backend:

  • Express.js with TypeScript
  • Prisma with PostgreSQL
  • Turborepo

Cloud & AI

  • AWS EC2
  • Google Cloud tts API (Text-to-Speech)

Getting Started

Prerequisites

Make sure you have the following installed:

  • Node.js
  • pnpm

Installation

  1. Clone the repository:

  2. Install dependencies using pnpm:

    pnpm install

Configuration

  1. Set up environment variables: Create a .env file in the apps/server directory and add your configuration details:

    PORT = 5000
DATABASE_URL=""
JWT_SECRET=""
JWT_COOKIE_EXPIRES_IN="3d"
DEV_MODE=DEV
BACKENDURL=http://localhost:5000
EMAIL=
PASSWORD=
GCP=

  2. Add another .env in the apps/web

    NEXT_PUBLIC_BACKENDURL=http://localhost:5000

Running the Application

  1. Start the development server:

    pnpm dev

  2. The application should now be running on http://localhost:3000 for client & http://localhost:5000 for server

Contributing

We welcome contributions from everyone. Here’s how you can help:

  1. Fork the repository.
  2. Create a new branch. 
    git checkout -b feature-branch
  3. Make your changes.
  4. Commit your changes. 
    git commit -m "Description of changes"
  5. Push to your branch. 
    git push origin feature-branch
  6. Create a pull request.

License

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

Contributors

Together, we can build a more inclusive digital world. Thank you for being a part of Tech4All.