99 lines
2.5 KiB
Markdown
99 lines
2.5 KiB
Markdown
# Bookmark Manager
|
|
|
|
A modern, feature-rich bookmark management application with advanced organization, search, and synchronization capabilities.
|
|
|
|
## 📁 Project Structure
|
|
|
|
```
|
|
├── 📂 assets/ # Static assets (favicon, test data, etc.)
|
|
├── 📂 backend/ # Node.js/Express backend API
|
|
├── 📂 docs/ # Documentation and guides
|
|
├── 📂 frontend/ # HTML, CSS, JavaScript frontend
|
|
├── 📂 scripts/ # Setup and utility scripts
|
|
├── 📂 tests/ # Test files and verification scripts
|
|
├── bookmarks.html # Test data (sample bookmarks)
|
|
└── bookmarks_all_*.json # Test data (bookmark exports)
|
|
```
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Option 1: Docker Setup (Recommended)
|
|
```bash
|
|
./scripts/docker-setup.sh
|
|
```
|
|
|
|
### Option 2: Manual Setup
|
|
```bash
|
|
./scripts/setup.sh
|
|
```
|
|
|
|
## 📖 Documentation
|
|
|
|
- **[Getting Started](docs/GETTING_STARTED.md)** - Complete setup guide
|
|
- **[Docker Setup](docs/DOCKER_SETUP.md)** - Docker installation guide
|
|
- **[Manual Setup](docs/MANUAL_SETUP.md)** - Manual installation steps
|
|
- **[Troubleshooting](docs/TROUBLESHOOTING_SETUP.md)** - Common issues and solutions
|
|
|
|
## 🔧 Development
|
|
|
|
### Backend Development
|
|
```bash
|
|
cd backend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### Frontend Development
|
|
The frontend files are in the `frontend/` directory. Open `frontend/index.html` in your browser or serve via the backend.
|
|
|
|
### Database Management
|
|
```bash
|
|
cd backend
|
|
npm run db:backup # Create database backup
|
|
npm run db:status # Check database status
|
|
npm run db:reset # Reset database (development only)
|
|
```
|
|
|
|
## 🧪 Testing
|
|
|
|
Test files are organized in the `tests/` directory:
|
|
- **Integration Tests**: `tests/test_*.html`
|
|
- **Unit Tests**: `tests/test_*.js`
|
|
- **Verification Scripts**: `tests/verify_*.js`
|
|
|
|
## 📊 Features
|
|
|
|
- **Advanced Search & Filtering**
|
|
- **Folder Organization**
|
|
- **Link Testing & Validation**
|
|
- **Import/Export (HTML, JSON)**
|
|
- **Duplicate Detection**
|
|
- **Analytics & Statistics**
|
|
- **Mobile-Responsive Design**
|
|
- **Security Features**
|
|
- **Database Backup/Restore**
|
|
|
|
## 🔒 Security
|
|
|
|
- JWT-based authentication
|
|
- Email verification
|
|
- Password reset functionality
|
|
- Rate limiting
|
|
- Input validation
|
|
- CSRF protection
|
|
|
|
## 📱 Mobile Support
|
|
|
|
Fully responsive design with touch-friendly interactions and mobile-optimized UI.
|
|
|
|
## 🤝 Contributing
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Make your changes
|
|
4. Run tests
|
|
5. Submit a pull request
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the MIT License. |