8000
Skip to content

Latest commit

ย 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿง™โ€โ™‚๏ธ Digital Necromancer

Node.js Next.js TypeScript FastAPI Python Tailwind CSS

๐Ÿ“– Description

Digital Necromancer is a powerful full-stack web application that breathes new life into old, legacy codebases. Like a necromancer who revives the dead, this tool uses openai/gpt-oss-20b to analyze, explain, and modernize outdated code snippets and entire legacy projects.

Whether you're dealing with callback hell from the early 2010s, deprecated jQuery patterns, or ancient PHP code that makes you cry, Digital Necromancer transforms your legacy nightmares into modern, maintainable masterpieces.

Problem it solves:

  • Legacy code migration and modernization
  • Understanding complex, undocumented codebases
  • Learning modern alternatives to outdated patterns
  • Reducing technical debt in existing projects

โœจ Key Features

  • ๐Ÿ”ฎ AI-Powered Code Analysis: Leverages Hugging Face's GPT OSS 20B model for intelligent code understanding
  • โšก Modern Code Generation: Converts legacy patterns to modern equivalents (callbacks โ†’ async/await, jQuery โ†’ vanilla JS, etc.)
  • ๐Ÿ“š Intelligent Explanations: Provides detailed, plain-English explanations of code transformations
  • ๐Ÿ”’ Secure Code Input: Safe and secure interface for submitting sensitive legacy code
  • ๐Ÿ’พ Transformation History: Save and manage your code modernization projects (optional user profiles)
  • ๐ŸŽจ Beautiful UI: Modern, responsive interface built with Tailwind CSS and Shadcn/UI
  • โšก Fast Performance: Built on Next.js 14 with App Router for optimal performance

๐Ÿ› ๏ธ Tech Stack

Category Technology
Frontend Next.js 14 (App Router), React, TypeScript
Styling Tailwind CSS, Shadcn/UI
Backend Python FastAPI
AI/ML Hugging Face API (GPT OSS 20B)
Development Vite, ESLint, Prettier

๐Ÿš€ Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • Python (v3.8 or higher)
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/digital-necromancer.git
    cd digital-necromancer
  2. Install Frontend Dependencies

    # Navigate to frontend directory
    cd src/gptoss
    npm install
  3. Install Backend Dependencies

    # Navigate to backend directory (assuming backend is in separate folder)
    cd ../backend
    pip install -r requirements.txt
  4. Set up Environment Variables

    Create a .env.local file in the frontend root and .env in the backend root:

    Frontend (.env.local):

    NEXT_PUBLIC_API_URL=http://localhost:8000

    Backend (.env):

    HUGGINGFACE_API_KEY=your_huggingface_token_here
    CORS_ORIGINS=http://localhost:3000
  5. Start the Development Servers

    Backend (Terminal 1):

    cd backend
    uvicorn main:app --reload --port 8000

    Frontend (Terminal 2):

    cd src/gptoss
    npm run dev
  6. Open your browser

    Navigate to http://localhost:3000 to see the application running.

๐ŸŽฏ Usage

  1. Paste Your Legacy Code: Use the secure input interface to submit your old code
  2. Select Transformation Type: Choose the type of modernization you need
  3. AI Analysis: The system analyzes your code using advanced AI models
  4. Review Results: Get modernized code alongside detailed explanations
  5. Save & Export: Save your transformations and export the results

Screenshot placeholder: Add a screenshot of the main interface showing the before/after code comparison

๐Ÿ† Hackathon Innovation

What makes Digital Necromancer special:

  • ๐ŸŽฏ Real Problem, Real Solution: Addresses a $85B industry pain point
  • ๐Ÿค– AI-First Approach: Leverages cutting-edge open-source AI models
  • โšก Full-Stack Excellence: Modern tech stack with optimal performance
  • ๐ŸŽจ User-Centric Design: Intuitive interface that anyone can use
  • ๐Ÿ”ง Production Ready: Scalable architecture ready for real-world deployment

Technical Innovation:

  • Custom AI prompting for code analysis and transformation
  • Real-time code processing with FastAPI backend
  • Modern React components with TypeScript safety
  • Responsive design that works on all devices

๐Ÿšง What's Next?

Future Roadmap:

  • Support for more programming languages (Go, Rust, Swift)
  • Integration with GitHub for direct repository processing
  • AI-powered code review and security analysis
  • Team collaboration features
  • Enterprise deployment options

๐Ÿ—๏ธ Architecture

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   Frontend      โ”‚    โ”‚    Backend      โ”‚    โ”‚  Hugging Face   โ”‚
โ”‚   (Next.js)     โ”‚โ—„โ”€โ”€โ–บโ”‚   (FastAPI)     โ”‚โ—„โ”€โ”€โ–บโ”‚   AI Models     โ”‚
โ”‚                 โ”‚    โ”‚                 โ”‚    โ”‚                 โ”‚  
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
Variable Description Required Default
HUGGINGFACE_API_KEY Your Hugging Face API token for AI model access Yes -
NEXT_PUBLIC_API_URL Backend API URL for frontend requests Yes http://localhost:8000
CORS_ORIGINS Allowed CORS origins for the backend Yes http://localhost:3000

๐Ÿค Contributing

We welcome contributions from the community! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  3. Commit your changes
    git commit -m 'Add some amazing feature'
  4. Push to the branch
    git push origin feature/amazing-feature
  5. Open a Pull Request

Contribution Guidelines

  • Follow the existing code style and conventions
  • Add tests for new features
  • Update documentation as needed
  • Ensure all tests pass before submitting

๐Ÿ“„ License

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

Usage Rights

You are free to use this project by:

  1. Creating your own Hugging Face token at Hugging Face
  2. Setting up your environment by adding your token to the backend .env file
  3. Running the application following the installation instructions above

The Apache 2.0 license allows you to freely use, modify, and distribute this software for both personal and commercial purposes.

๐Ÿ™ Acknowledgments

  • Hugging Face for providing powerful AI models
  • The open-source community for the amazing tools and libraries
  • All contributors who help improve this project

๐Ÿ“ž Support

If you encounter any issues or have questions:

  • Open an issue on GitHub
  • Check the documentation
  • Join our community discussions

Made with โค๏ธ and a touch of digital necromancy

About

No description, website, or topics provided.

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0