Skip to content

ThinkInkTeam/ThinkInk-Frontend

Repository files navigation

ThinkInk Logo

ThinkInk Frontend

Translating Brain Signals into Text

Live Demo β€’ Getting Started β€’ Tech Stack β€’ Project Structure


πŸ“– About

ThinkInk is a cutting-edge platform that translates brain signals (EEG/EMG) into text using advanced AI and machine learning technologies. This frontend application provides an intuitive, accessible interface for users to interact with neural data processing capabilities.

Key Highlights

  • 🧠 Neural Signal Processing β€” Upload and process EEG/EMG files in real-time
  • πŸ€– AI-Powered Translation β€” Convert brain signals to text using advanced ML models
  • πŸ” Secure Authentication β€” Google OAuth integration with JWT token management
  • πŸ“± Progressive Web App β€” Offline capabilities with service worker support
  • β™Ώ Accessibility First β€” Designed specifically for users with speech impairments
  • ⚑ Real-time Feedback β€” Toast notifications and smooth animations

πŸ› οΈ Tech Stack

Category Technologies
Framework React Vite
Styling Tailwind CSS Framer Motion
Routing React Router
HTTP Client Axios
Authentication Google OAuth JWT
UI Components Lucide Swiper
PWA Workbox Vite PWA
Dev Tools ESLint Husky Commitlint
Runtime Bun

Dependencies Overview

Core

  • React 18 β€” Modern React with concurrent features
  • Vite β€” Lightning-fast build tool and dev server
  • React Router DOM v7 β€” Client-side routing

Styling & Animation

API & State

Authentication

PWA


πŸ—οΈ Project Structure

ThinkInk-Frontend/
β”œβ”€β”€ πŸ“ public/                    # Static assets
β”‚   β”œβ”€β”€ robots.txt               # SEO robots configuration
β”‚   └── sitemap.xml              # SEO sitemap
β”‚
β”œβ”€β”€ πŸ“ dev-dist/                  # PWA service worker files
β”‚   β”œβ”€β”€ sw.js                    # Service worker
β”‚   └── workbox-*.js             # Workbox runtime
β”‚
β”œβ”€β”€ πŸ“ src/                       # Source code
β”‚   β”œβ”€β”€ πŸ“„ App.jsx               # Root application component
β”‚   β”œβ”€β”€ πŸ“„ main.jsx              # Application entry point
β”‚   β”œβ”€β”€ πŸ“„ index.css             # Global styles
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ api/                   # API layer
β”‚   β”‚   β”œβ”€β”€ axiosInstance.jsx    # Axios configuration
β”‚   β”‚   β”œβ”€β”€ auth.jsx             # Authentication API
β”‚   β”‚   β”œβ”€β”€ register.jsx         # Registration API
β”‚   β”‚   └── logout.jsx           # Logout API
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ assets/                # Static assets
β”‚   β”‚   └── πŸ“ images/           # Image files
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ common/                # Reusable UI components
β”‚   β”‚   β”œβ”€β”€ AppleBtn.jsx         # Apple sign-in button
β”‚   β”‚   β”œβ”€β”€ GoogleBtn.jsx        # Google sign-in button
β”‚   β”‚   β”œβ”€β”€ CheckBox.jsx         # Custom checkbox
β”‚   β”‚   β”œβ”€β”€ SwitchBtn.jsx        # Toggle switch
β”‚   β”‚   β”œβ”€β”€ GreenTag.jsx         # Status tag component
β”‚   β”‚   β”œβ”€β”€ Loader.jsx           # Loading spinner
β”‚   β”‚   └── TopNav.jsx           # Top navigation bar
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ components/            # Feature components
β”‚   β”‚   β”œβ”€β”€ LanguageSelector.jsx # Language picker
β”‚   β”‚   β”œβ”€β”€ πŸ“ header/           # Header component
β”‚   β”‚   β”œβ”€β”€ πŸ“ hero/             # Hero section
β”‚   β”‚   β”œβ”€β”€ πŸ“ footer/           # Footer component
β”‚   β”‚   β”œβ”€β”€ πŸ“ articles/         # Articles display
β”‚   β”‚   β”œβ”€β”€ πŸ“ codeSample/       # Code examples
β”‚   β”‚   β”œβ”€β”€ πŸ“ fileupload/       # EEG/EMG file upload
β”‚   β”‚   β”œβ”€β”€ πŸ“ pricingCard/      # Pricing cards
β”‚   β”‚   β”œβ”€β”€ πŸ“ FQA/              # FAQ section
β”‚   β”‚   β”œβ”€β”€ πŸ“ sideMenu/         # Side navigation
β”‚   β”‚   β”œβ”€β”€ πŸ“ side-slider/      # Slider component
β”‚   β”‚   β”œβ”€β”€ πŸ“ sectionText/      # Text sections
β”‚   β”‚   β”œβ”€β”€ πŸ“ response-popup/   # Response modal
β”‚   β”‚   β”œβ”€β”€ πŸ“ Enterprise/       # Enterprise section
β”‚   β”‚   └── πŸ“ PATIENTS/         # Patients section
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ context/               # React Context providers
β”‚   β”‚   └── UploadContext.jsx    # File upload state
β”‚   β”‚
β”‚   β”œβ”€β”€ πŸ“ global/                # Global utilities
β”‚   β”‚   └── styles.css           # Global CSS variables
β”‚   β”‚
β”‚   └── πŸ“ pages/                 # Route pages
β”‚       β”œβ”€β”€ About.jsx            # About page
β”‚       β”œβ”€β”€ Api.jsx              # API documentation
β”‚       β”œβ”€β”€ BluetoothConnect.jsx # Bluetooth device connection
β”‚       β”œβ”€β”€ ComingSoon.jsx       # Coming soon placeholder
β”‚       β”œβ”€β”€ Contact.jsx          # Contact form
β”‚       β”œβ”€β”€ Login.jsx            # Login page
β”‚       β”œβ”€β”€ Register.jsx         # Registration page
β”‚       β”œβ”€β”€ Pricing.jsx          # Pricing page
β”‚       β”œβ”€β”€ Profile.jsx          # User profile
β”‚       └── NotFound.jsx         # 404 page
β”‚
β”œβ”€β”€ πŸ“„ index.html                 # HTML entry point
β”œβ”€β”€ πŸ“„ package.json               # Dependencies & scripts
β”œβ”€β”€ πŸ“„ vite.config.js             # Vite configuration
β”œβ”€β”€ πŸ“„ tailwind.config.js         # Tailwind configuration
β”œβ”€β”€ πŸ“„ postcss.config.js          # PostCSS configuration
β”œβ”€β”€ πŸ“„ eslint.config.js           # ESLint configuration
β”œβ”€β”€ πŸ“„ Dockerfile                 # Docker configuration
└── πŸ“„ README.md                  # Project documentation

🚦 Getting Started

Prerequisites

  • Bun (v1.0 or higher) β€” Fast all-in-one JavaScript runtime

Installation

# Install Bun (if not already installed)
curl -fsSL https://bun.sh/install | bash

# Clone the repository
git clone https://github.com/your-username/ThinkInk-Frontend.git
cd ThinkInk-Frontend

# Install dependencies
bun install

Development

# Start development server
bun run dev

# Run linting
bun run lint

# Setup git hooks
bun run prepare

Production

# Build for production
bun run build

# Preview production build
bun run preview

🌐 Deployment

This project is optimized for deployment on Vercel:

  • βœ… Automatic builds on push
  • βœ… SEO optimization with sitemap.xml
  • βœ… Progressive Web App capabilities
  • βœ… Performance optimizations
  • βœ… Docker support available

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/new-feature
  3. Commit changes: git commit -m 'feat: add new feature'
  4. Push to branch: git push origin feat/new-feature
  5. Submit a pull request

Please follow the Branch Naming Conventions and use conventional commits.


πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for details.


🌐 Live Demo β€’ πŸ“š API Docs β€’ πŸ’¬ Contact Us

About

Transforms brainwaves into fluent, natural speech.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages