Skip to content

Nuclear-app/app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

320 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nuclear - Your AI-Powered Learning Companion

Nuclear - AI-Powered Learning

Nuclear

Transform your learning experience with AI-powered note-taking and knowledge organization

Features · Getting Started · Study Modes · Development


Features

  • 🤖 AI-Powered Learning

    • Smart note-taking assistance
    • Automatic content summarization
    • Intelligent knowledge organization
  • 📚 Multiple Study Modes

    • Deathmarch: Quick note-taking for immediate ideas
    • Story & Sword: Structured learning with resources
    • Just the Story: Automated content processing
  • 📁 Smart Organization

    • Hierarchical block and crate system
    • Easy file management
    • Seamless content organization
  • 🔄 Real-time Processing

    • OCR for images and PDFs
    • Audio transcription
    • Instant content analysis

Study Modes

Deathmarch

Perfect for when you have ideas in mind and want to start notetaking immediately. Jump right in and capture your thoughts with AI assistance.

Story & Sword

Ideal for structured learning. Upload your resources and let Nuclear help you understand and organize them effectively.

Just the Story

Simply dump your content and let Nuclear handle the rest. Get automatic summaries and insights from your materials.

Getting Started

  1. Clone the repository:

    git clone https://github.com/yourusername/nuclear.git
    cd nuclear
  2. Install dependencies:

    npm install
    # or
    yarn install
    # or
    pnpm install
  3. Set up your environment variables:

    cp .env.example .env.local

    Update the following variables in .env.local:

    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
    
  4. Run the development server:

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
  5. Open http://localhost:3000 in your browser.

Development

Nuclear is built with:

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

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

About

Ze App.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages