Skip to content

README.md

Latest commit

 

History

History
74 lines (58 loc) · 2.47 KB

README.md

File metadata and controls

74 lines (58 loc) · 2.47 KB

ResearchHub – Netflix for Research Papers

ResearchHub is a modern, dark-themed full-stack platform designed for discovering, saving, and managing research papers. Inspired by Netflix, Medium, and Google Scholar, it provides a premium user experience for academics and tech enthusiasts.

🚀 Features

  • User Authentication: Secure signup and login with JWT.
  • Interest Selection: Personalize your feed by choosing from various tech categories.
  • Dynamic Dashboard: Sections for Recommended, Trending, and Recently Added papers.
  • Search Functionality: Real-time filtering by title, category, or keywords.
  • My Library: Save your favorite papers for quick access.
  • Reading History: Automatically track papers you've viewed.
  • Premium UI: Responsive design with glassmorphism, smooth animations, and a sleek dark theme.

🛠 Tech Stack

  • Frontend: React.js, Framer Motion, Lucide Icons, Vanilla CSS.
  • Backend: Node.js, Express.js.
  • Database: Local JSON files (using fs module).
  • Authentication: JWT & BcryptJS.

📂 Project Structure

  • /backend: Express server, controllers, routes, and JSON data.
  • /frontend: React application (Vite).
  • /backend/data: Contains users.json, papers.json, saved.json, and history.json.

⚙️ Setup Instructions

1. Prerequisites

  • Node.js (v14+)
  • npm or yarn

2. Installation

Clone the repository and install dependencies for both frontend and backend:

# Install root dependencies
npm install

# Install backend dependencies
cd backend
npm install

# Install frontend dependencies
cd ../frontend
npm install

3. Environment Variables

Create a .env file in the backend directory:

PORT=5000
JWT_SECRET=your_secret_key_here

4. Running the Application

You can run both the server and client simultaneously from the root directory:

npm start

Alternatively, run them separately:

  • Backend: cd backend && npm run dev (Runs on port 5000)
  • Frontend: cd frontend && npm run dev (Runs on port 5173)

📖 Usage

  1. Signup: Create an account.
  2. Interests: Select categories that interest you (AI, Blockchain, etc.).
  3. Dashboard: Browse papers. Hover over cards for a premium feel.
  4. Search: Use the top search bar to find specific topics.
  5. Save: Click the bookmark icon to save papers to your Library.
  6. History: View previously read papers in the History tab.

📄 License

This project is for educational purposes.