Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 2.23 KB

README.md

File metadata and controls

91 lines (60 loc) · 2.23 KB

Frontend Assignment

Description

This is a React-based application that allows users to interact with PDF documents via a chat interface. The application consists of three main components:

  • Sidebar: For selecting and managing PDF files.
  • Preview: For viewing the contents of the selected PDF.
  • Chat: For conversing with an AI or chatbot about the PDF contents.

Features

  • Interactive PDF viewer
  • Resizable layout components
  • Sidebar for file selection
  • Chat interface for AI interactions

Installation

Prerequisites

  • Node.js (version 18.3.1 or higher)

Clone the repository

git clone https://github.com/username/frontend-assignment.git
cd frontend-assignment

Install depedencies

npm install

Usage

Start the project

npm start

The application will start a development server and open the project in your default web browser. By default, it will be accessible at http://localhost:3000.

Configuration

No additional configuration is required to get started. Ensure that you have the necessary dependencies installed.

File Structure

  • src/: Contains source code files
  • components/: Contains React components such as Sidebar, Preview, and Chat
  • styles/: Contains SCSS files for styling
  • public/: Contains public assets such as the HTML template
  • package.json: Contains project metadata and dependencies
  • README.md: This README file

Examples

Here’s a basic example of how the layout looks:

  • Sidebar: Allows file selection and management.
  • Preview: Displays the selected PDF.
  • Chat: Provides an interface for chatting with an AI about the PDF.

Contributing

If you would like to contribute to this project, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Create a new Pull Request.

License

Contact

Acknowledgements

Libraries and Tools: