Skip to content

bheemrc/resonance-draftpro-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Resonance DraftPro UI

Overview

Resonance DraftPro UI is a web-based research paper drafting tool built using React and TypeScript. It provides a structured editor interface for managing research content, auto-generating sections, and handling citations efficiently.

Features

  • Structured Research Editor: Organize content into sections such as Introduction, Methodology, and Results.
  • Auto-Generation of Sections: AI-powered suggestions to generate structured content.
  • Citation Management: Support for BibTeX references.
  • Custom Section Handling: Create and format research-specific sections dynamically.
  • Live PDF Preview: View formatted research documents in real-time.
  • Multiple Paper Formats: Supports various publication styles.

Supported Paper Formats

  • arXiv Standard Format
  • IEEE Conference
  • ACM Conference

Tech Stack

  • Frontend: React (created using npx create-react-app)
  • UI Framework: Material-UI (MUI)
  • State Management: React Hooks
  • Styling: Tailwind CSS
  • Build System: Vite/Webpack
  • Package Manager: npm/yarn

Project Structure

src/
 ├── components/
 │   ├── ResearchGenerator/ (Main editor UI)
 │   ├── AppHeader.tsx (Top navigation bar)
 │   ├── ContentArea.tsx (Main content display)
 │   ├── Sidebar.tsx (Navigation and sections)
 │   ├── CitationManager/ (Handle citations and references)
 │   ├── EditorToolbar.tsx (Formatting options)
 │   ├── PdfPreview.tsx (Live preview feature)
 │   ├── PaperPlanner.tsx (Research planning tools)
 ├── hooks/ (Custom React hooks)
 ├── services/ (API integrations and local storage handling)
 ├── utils/ (Helper functions)
 ├── index.tsx (Entry point)
 ├── App.tsx (Main app component)
 ├── App.css (Global styles)

Installation

Prerequisites

  • Node.js (>= 16.x)
  • npm or yarn

Steps to Run Locally

  1. Clone the repository:

    git clone https://github.com/rajulubheem/resonance-draftpro-ui.git
    cd resonance-draftpro-ui
    git checkout master
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Start the development server:

    npm run start
    # or
    yarn start
  4. Run this collaborator - Mandatory - TODO: For future use, collaboration to edit the paper draft.

    # Open new tab and run this command.
    cd src/components/ResearchGenerator/components/collabrate
    $ node collab-server.js
    
  5. Open the app in the browser:

    http://localhost:3000
    

Contributing

  1. Fork the repository and clone it locally.
  2. Create a feature branch:
    git checkout -b feature-new
  3. Make your changes and commit:
    git commit -m "Added new feature"
  4. Push to your branch:
    git push origin feature-new
  5. Create a pull request on GitHub.

License

This project is licensed under the Apache License 2.0 License.

Contact

For any questions or suggestions, feel free to reach out.


Disclaimer

AI-Generated Content Notice

Resonance DraftPro UI is an AI-powered research drafting tool designed to assist users in structuring, generating, and refining research documents. While AI can accelerate the drafting process, users bear full responsibility for verifying, refining, and ensuring the accuracy of the generated content before submission or publication.

Limitations of AI-Generated Content

  1. Fact-Checking & Accuracy

    • AI-generated content may contain factual inaccuracies, outdated information, or misleading statements.
    • Users must independently verify all claims, data points, and references from credible sources.
  2. Plagiarism & Originality

    • AI does not guarantee originality, and some outputs may resemble existing texts.
    • Users should check for plagiarism and ensure proper citations before submitting work.
  3. Ethical & Academic Compliance

    • Academic institutions, conferences, and publishers may have strict policies regarding AI-assisted writing.
    • Users should adhere to their respective ethical guidelines and clearly disclose AI-generated content where required.
  4. Bias, Interpretation & Objectivity

    • AI models generate content based on training data, which may contain biases or incomplete perspectives.
    • Users must critically evaluate the output to ensure fairness, neutrality, and adherence to academic standards.
  5. No Legal, Medical, or Scientific Authority

    • AI-generated content should not be considered expert advice in legal, medical, or scientific domains.
    • Users should consult subject-matter experts before relying on AI-generated research for critical decisions.

Our Approach to Reducing Bias & Inaccuracy

At Resonance DraftPro UI, we aim to minimize errors and biases in research generation through:

  • Multi-source aggregation: Pulling insights from diverse references to ensure balanced perspectives.
  • Cross-referencing citations: Reducing misinformation by suggesting frequently cited and reputable sources.
  • User-driven customization: Allowing manual edits and refinements to prevent AI misinterpretation.

However, bias cannot be entirely eliminated, and the responsibility remains with the user to review and validate content before using it in any official capacity.

User Responsibility & Compliance

By using this tool, you agree to:
Verify all AI-generated content before using it in academic or professional work.
Ensure compliance with ethical, institutional, and publishing guidelines regarding AI-assisted writing.
Use AI as a support tool, not a substitute for critical thinking and expertise.
Acknowledge that Resonance DraftPro UI does not provide any guarantees on accuracy or compliance.

Legal Notice

  • Resonance DraftPro UI and its creators are not liable for any inaccuracies, ethical violations, or misuse of AI-generated content.
  • The tool does not provide legal, financial, medical, or authoritative research guidance.
  • Users must independently determine whether AI-generated content is suitable for their intended use.

About

Resonance DraftPro: A smart, AI-powered tool designed to assist researchers and writers in drafting, refining, and enhancing research papers and academic manuscripts with ease.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages