Skip to content

BrandonGarate177/CoTeX-Front

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoTeX

CoTeX is a developer-focused note-taking application that seamlessly integrates with GitHub repositories, featuring a powerful markdown editor with LaTeX math support, allowing developers to create, organize, and synchronize documentation directly within their project workflows.

CoTeX_gif

Key Features

  • GitHub Integration: Real-time sync with repositories and commit tracking
  • Advanced Markdown Editor: Mathematical notation support with LaTeX rendering
  • Local & Cloud Sync: Hybrid storage approach for reliability and performance
  • Desktop Application: Built with Electron and React for cross-platform compatibility
  • Developer-Centric: Designed specifically for technical documentation and code notes
  • Wiki-Style Linking: Connect notes with powerful cross-references
  • File Management: Integrated file browser and project organization

Tech Stack

  • Frontend: React 19, TypeScript, Tailwind CSS
  • Desktop: Electron with custom protocol handling
  • Editor: TipTap with custom extensions for LaTeX and wiki links
  • Backend: Supabase for authentication and data sync
  • Build Tools: Webpack, Electron Builder

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/brandongarate/CoTeX-Front.git
cd CoTeX-Front
  1. Install dependencies:
npm install
cd app && npm install && cd ..
  1. Set up environment variables:
cp app/environment.template app/.env
# Edit app/.env with your Supabase credentials
  1. Start the development server:
npm start

Architecture

CoTeX follows a modular architecture with clear separation of concerns:

  • Electron Main Process: Handles file system operations, window management, and deep-link authentication
  • React Renderer: Manages UI components, state, and user interactions
  • Authentication Flow: OAuth with GitHub using system browser and deep-link callbacks
  • File System Integration: Direct file operations with real-time sync capabilities

Development

Available Scripts

  • npm start - Start development server
  • npm run build - Build for production
  • npm run electron:build - Build Electron app
  • npm run dist - Create distributable packages

Project Structure

CoTeX-Front/
├── app/                    # React application
│   ├── src/
│   │   ├── components/     # React components
│   │   ├── pages/          # Main application pages
│   │   ├── utils/          # Utility functions
│   │   └── types/          # TypeScript definitions
│   └── public/             # Static assets
├── electron/               # Electron main process
└── assets/                 # Application assets

License

All packaged builds are © 2025 Brandon Garate. Distributed binaries are for personal or team use only. Please see the main CoTeX repository for source code licensing terms.

Support

For issues, feature requests, or contributions, please visit CoTeX.md/Contact

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published