A TypeScript-based project for sign language processing, including gesture recognition and translation. This repository is designed to provide real-time solutions for interpreting sign language using modern tools and frameworks.
- Real-time gesture recognition
- Sign language translation
- Modular and scalable TypeScript codebase
Before setting up the project, ensure you have the following installed:
- Node.js (v16 or higher recommended)
- npm or yarn
- TypeScript (globally installed)
To install TypeScript globally: npm install -g typescript
Clone this repository to your local machine: git clone https://github.com/kevinjosethomas/sign-language-processing.git
Navigate into the project directory:
Install all required dependencies using npm or yarn:
npm install
Compile the TypeScript files into JavaScript using the following command: tsc
This will generate a dist folder (or as specified in your tsconfig.json) containing the compiled JavaScript files.
After successful compilation, run the application locally using Node.js: node dist/index.js
If your entry point is different (e.g., app.ts), adjust accordingly:
node dist/app.js
To start a development server with live reloading, use a tool like ts-node-dev. Install it globally if not already installed:
npm install -g ts-node-dev
Run the development server: ts-node-dev src/index.ts
This project uses ESLint and Prettier for code quality. Run linting with: npm run lint
Format code with Prettier: npm run format
Here’s an overview of the key folders and files in this repository:
The following scripts are defined in package.json:
| Script | Description |
|---|---|
start |
Runs the compiled JavaScript files |
build |
Compiles TypeScript into JavaScript |
dev |
Starts a development server using ts-node |
lint |
Runs ESLint to check code quality |
format |
Formats code using Prettier |
Contributions are welcome! Follow these steps to contribute:
- Fork this repository.
- Create a new branch:
git checkout -b feature-name. - Commit your changes:
git commit -m "Add feature". - Push to your branch:
git push origin feature-name. - Open a pull request.
This project is licensed under the MIT License. See LICENSE for details.