desc

DEPLOYMENT.md

@@ -1,213 +0,0 @@
-# Deployment Guide
-
-This guide will help you deploy your multilingual paper database to various hosting platforms.
-
-## Prerequisites
-
-Before deploying, ensure you have:
-- All project files in your local directory
-- A GitHub account (for most deployment options)
-- Basic familiarity with command line (optional, depending on method)
-
-## Option 1: GitHub Pages (Recommended - Free)
-
-GitHub Pages is perfect for static websites and offers free hosting with a custom domain option.
-
-### Step 1: Create GitHub Repository
-1. Go to [GitHub](https://github.com) and sign in
-2. Click the "+" icon → "New repository"
-3. Name it `multilingual-paperbase`
-4. Make it public (required for free GitHub Pages)
-5. Click "Create repository"
-
-### Step 2: Upload Your Files
-```bash
-# Initialize git in your project folder
-git init
-
-# Add all files
-git add .
-
-# Commit the files
-git commit -m "Initial commit"
-
-# Add your GitHub repository as remote
-git remote add origin https://github.com/crystina-z/multilingual-paperbase.git
-
-# Push to GitHub
-git push -u origin main
-```
-
-### Step 3: Enable GitHub Pages
-1. Go to your repository on GitHub
-2. Click "Settings" tab
-3. Scroll down to "Pages" section (in the left sidebar)
-4. Under "Source", select "Deploy from a branch"
-5. Choose "main" branch and "/ (root)" folder
-6. Click "Save"
-
-### Step 4: Access Your Site
-Your site will be available at:
-`https://crystina-z.github.io/multilingual-paperbase`
-
-**Note**: It may take a few minutes for the site to become available.
-
-## Option 2: Netlify (Free Tier)
-
-Netlify offers excellent performance and features like automatic deployments.
-
-### Method A: Drag & Drop (Easiest)
-1. Go to [netlify.com](https://netlify.com) and sign up
-2. Drag your entire project folder to the deploy area
-3. Your site is instantly live!
-4. Netlify will give you a random URL (you can customize it)
-
-### Method B: Connect to Git
-1. Sign up at [netlify.com](https://netlify.com)
-2. Click "New site from Git"
-3. Connect your GitHub account
-4. Select your repository
-5. Deploy settings:
-   - Build command: (leave empty)
-   - Publish directory: `.` (root)
-6. Click "Deploy site"
-
-## Option 3: Vercel (Free Tier)
-
-Vercel is great for performance and developer experience.
-
-### Step 1: Install Vercel CLI
-```bash
-npm install -g vercel
-```
-
-### Step 2: Deploy
-```bash
-# Navigate to your project directory
-cd multilingual-paperbase
-
-# Deploy
-vercel
-
-# Follow the prompts:
-# - Link to existing project? No
-# - Project name: multilingual-paperbase
-# - Directory: ./
-```
-
-### Step 3: Access Your Site
-Vercel will provide you with a URL like:
-`https://multilingual-paperbase.vercel.app`
-
-## Option 4: Firebase Hosting (Free Tier)
-
-Firebase offers reliable hosting with Google's infrastructure.
-
-### Step 1: Install Firebase CLI
-```bash
-npm install -g firebase-tools
-```
-
-### Step 2: Login and Initialize
-```bash
-# Login to Firebase
-firebase login
-
-# Initialize Firebase in your project
-firebase init hosting
-
-# Answer the prompts:
-# - Use existing project? No
-# - Project name: multilingual-paperbase
-# - Public directory: ./
-# - Configure as single-page app? No
-# - Overwrite index.html? No
-```
-
-### Step 3: Deploy
-```bash
-firebase deploy
-```
-
-Your site will be available at the URL provided by Firebase.
-
-## Option 5: Traditional Web Hosting
-
-If you have a traditional web hosting account:
-
-1. Upload all files to your web server's public directory
-2. Ensure `index.html` is in the root directory
-3. Your site will be available at your domain
-
-## Custom Domain Setup
-
-### GitHub Pages
-1. Go to repository Settings → Pages
-2. Under "Custom domain", enter your domain
-3. Add a CNAME record pointing to `YOUR_USERNAME.github.io`
-4. Create a `CNAME` file in your repository with your domain name
-
-### Netlify
-1. Go to Site settings → Domain management
-2. Click "Add custom domain"
-3. Follow the DNS configuration instructions
-
-### Vercel
-1. Go to your project dashboard
-2. Click "Settings" → "Domains"
-3. Add your domain and configure DNS
-
-## Post-Deployment Checklist
-
-After deploying, verify:
-
-- [ ] All pages load correctly
-- [ ] Search functionality works
-- [ ] Filters are working
-- [ ] Mobile responsiveness
-- [ ] No console errors
-- [ ] Images and assets load properly
-
-## Troubleshooting
-
-### Common Issues
-
-**Site not loading:**
-- Check if all files were uploaded
-- Verify `index.html` is in the root directory
-- Check browser console for errors
-
-**Search not working:**
-- Ensure `script.js` is properly loaded
-- Check if data files are accessible
-- Verify CORS settings if loading external data
-
-**Styling issues:**
-- Confirm `styles.css` is loaded
-- Check for CSS syntax errors
-- Verify file paths are correct
-
-### Performance Optimization
-
-1. **Compress images** if you have any
-2. **Minify CSS/JS** for production
-3. **Enable gzip compression** on your server
-4. **Use a CDN** for better global performance
-
-## Security Considerations
-
-- Keep your repository public if using GitHub Pages
-- Don't include sensitive data in your code
-- Use HTTPS (most platforms provide this automatically)
-- Regularly update dependencies if you add any
-
-## Maintenance
-
-- Regularly update your paper database
-- Monitor site performance
-- Keep backups of your data
-- Test on different browsers and devices
-
----
-
-**Need help?** Open an issue on GitHub or check the platform's documentation for specific troubleshooting steps. 

README.md

@@ -10,153 +10,28 @@ pinned: false
 ---
 # Multilingual Paper Database
 
-A modern, responsive web application for searching and browsing academic papers with multilingual support.
+## 📝 Overview
 
-## Features
+A web application for searching and browsing academic papers from given .bib file,
+Currently the paperbased are from a filtered version of [ACL Anthology](https://aclanthology.org/),
+working to incorporate papers from IR venues. 
 
-- 🔍 **Advanced Search**: Search across titles, abstracts, and authors with multiple keywords
-- 🌍 **Multilingual Support**: Search in multiple languages simultaneously
-- 📅 **Year Filtering**: Filter papers by publication year with dual-range slider
-- 🎯 **Conference Filtering**: Filter by specific conferences or venues
-- 📝 **Abstract Filtering**: Show/hide papers with or without abstracts
-- 📱 **Responsive Design**: Works perfectly on desktop, tablet, and mobile
-- ⚡ **Fast Performance**: Optimized for quick search and filtering
-- 🎨 **Modern UI**: Beautiful, intuitive interface with smooth animations
 
-## Quick Start
+## 🛠️ Usage
 
-1. **Clone the repository**:
-   ```bash
-   git clone https://github.com/crystina-z/multilingual-paper-database.git
-   cd multilingual-paper-database
-   ```
+Currently it allows to 
+- add multiple search keywords and filtering keywords,
+- filter by year, conference, and star papers,
+- export current search results to .bib file,
+- export starred papers to .bib file,
+- export current search status into .json file
+- load previous search status the saved .json file
 
-2. **Open in your browser**:
-   Simply open `index.html` in your web browser, or serve it using a local server:
-   ```bash
-   # Using Python
-   python -m http.server 8000
-   
-   # Using Node.js
-   npx serve .
-   
-   # Using PHP
-   php -S localhost:8000
-   ```
+## 💬 Feedback or Adaptation
 
-3. **Access the application**:
-   Open your browser and go to `http://localhost:8000`
-
-## Data Management
-
-### Adding Papers
-Use the Python script to add new papers to the database:
-```bash
-python generate_multilingual_bib.py
+Feel free to leave feedback by emailing me or in the Community.
+If you want to use the project on your own .bib file,
+it requires only a single line of change in the `script.js`:
+```javascript
+let response = await fetch('data/multilingual_papers.bib'); // <--- change this line
 ```
-
-### Managing Conferences
-Edit `conferences.txt` to add or remove conferences from the filter options.
-
-## Deployment Options
-
-### 1. GitHub Pages (Recommended - Free)
-
-1. **Push to GitHub**:
-   ```bash
-   git add .
-   git commit -m "Initial commit"
-   git push origin main
-   ```
-
-2. **Enable GitHub Pages**:
-   - Go to your repository on GitHub
-   - Click "Settings" → "Pages"
-   - Select "Deploy from a branch"
-   - Choose "main" branch and "/ (root)" folder
-   - Click "Save"
-
-3. **Your site will be available at**:
-   `https://crystina-z.github.io/multilingual-paper-database`
-
-### 2. Netlify (Free Tier)
-
-1. **Drag & Drop**:
-   - Go to [netlify.com](https://netlify.com)
-   - Drag your project folder to the deploy area
-   - Your site is instantly live!
-
-2. **Or connect to Git**:
-   - Connect your GitHub repository
-   - Netlify will automatically deploy on every push
-
-### 3. Vercel (Free Tier)
-
-1. **Install Vercel CLI**:
-   ```bash
-   npm i -g vercel
-   ```
-
-2. **Deploy**:
-   ```bash
-   vercel
-   ```
-
-### 4. Firebase Hosting (Free Tier)
-
-1. **Install Firebase CLI**:
-   ```bash
-   npm install -g firebase-tools
-   ```
-
-2. **Initialize and deploy**:
-   ```bash
-   firebase login
-   firebase init hosting
-   firebase deploy
-   ```
-
-## Customization
-
-### Styling
-- Edit `styles.css` to customize colors, fonts, and layout
-- The design uses CSS custom properties for easy theming
-
-### Functionality
-- Modify `script.js` to add new features or change search behavior
-- Update the data structure in the JavaScript file to match your paper format
-
-### Data
-- Replace the sample data with your own paper database
-- Ensure your data follows the expected JSON structure
-
-## Browser Support
-
-- ✅ Chrome (recommended)
-- ✅ Firefox
-- ✅ Safari
-- ✅ Edge
-- ⚠️ Internet Explorer (limited support)
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Test thoroughly
-5. Submit a pull request
-
-## License
-
-This project is open source and available under the [MIT License](LICENSE).
-
-## Support
-
-If you encounter any issues or have questions:
-- Open an issue on GitHub
-- Check the browser console for error messages
-- Ensure all files are in the correct directory structure
-
----
-
-**Happy researching! 🎓**