Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 2.55 KB

README.md

File metadata and controls

111 lines (86 loc) · 2.55 KB

ArXiv Browser

A modern ArXiv paper browser built with Tauri + Vue3 + Python, featuring a clean interface and convenient paper management functionality.

Features

  • 📱 Modern responsive interface
  • 🔍 Paper category filtering
  • 📖 Reading status tracking
  • 🔗 Quick paper link opening
  • 🌙 Light/Dark theme switching

Tech Stack

  • Frontend: Vue 3 + Vite + Pinia
  • Backend: Python + FastAPI
  • Desktop: Tauri
  • Styling: SCSS

Development Setup

Prerequisites

  • Node.js (>= 16)
  • Python 3.8+
  • Rust

Installation Steps

  1. Clone the repository
git clone https://github.com/yourusername/arxiv-paper-browser.git
cd arxiv-paper-browser
  1. Setup backend
cd backend
python -m venv venv
source venv/bin/activate # On Windows: .\venv\Scripts\activate
pip install -r requirements.txt
  1. Setup frontend
cd daily-arxiv
npm install

Running the Application

You can run the application in development mode:

npm run tauri dev

Or run frontend and backend separately:

Backend:

cd backend
python -m main

Frontend:

cd daily-arxiv
npm run dev

The application will be available at:

Project Structure

.
├── backend/
│   ├── database/     # Database models and operations
│   ├── scraper/      # ArXiv API integration
│   ├── tests/        # Backend tests
│   └── main.py       # FastAPI application
├── daily-arxiv/      # Frontend application
│   ├── public/       # Static assets
│   └── src/
│       ├── assets/   # Styles and images
│       ├── components/# Vue components
│       ├── stores/   # Pinia stores
│       └── views/    # Page components
└── src-tauri/        # Tauri desktop application

Contributing

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

License

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

Acknowledgments

  • ArXiv API for providing the paper data
  • Vue.js for the excellent frontend framework
  • FastAPI for the powerful backend framework
  • Tauri for the desktop application framework