Skip to content

praizjosh/document-explorer

Repository files navigation

Document Explorer

Document Explorer is a web application that allows users to explore and manage documents and folders. This application provides a user-friendly interface to view, sort, and filter documents based on various criteria. It is built using React and utilizes React Router for seamless navigation.

Deployed on Vercel --> https://document-explorer.vercel.app/

Features

  • Sorting: Sort documents by name, date, size, or file type.
  • Filtering: Filter documents by filename for quick search.
  • Folder Structure: View documents organized within folders.
  • Responsive Design: Accessible and functional on various devices.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js installed on your local machine.

Getting Started

To set up this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/praizjosh/document-explorer.git
  2. Navigate to the project directory:

    cd document-explorer
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm run dev

    The application will be accessible at http://localhost:5173.

Usage

  1. Explore Documents: Navigate through folders and view documents.
  2. Sort Documents: Use the dropdown menu to sort documents by name, date, size, or file type.
  3. Filter Documents: Use the search bar to filter documents by filename.
  4. Responsive Design: Enjoy a seamless experience on both desktop and mobile devices.

Dependencies

  • React: A JavaScript library for building user interfaces.
  • React Router: Declarative routing for React.js.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.

Development Tools

  • Vite: A fast development server and bundler for modern web development.
  • ESLint: A pluggable JavaScript linter to catch common mistakes.
  • Jest: A JavaScript testing framework for unit testing components.

Author

License

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