Faved

Faved is a simple self-hosted web application to store and organise web links. All data is stored locally.

100% free and open source. No ads, tracking, or data collection.

🧪 Try Live Demo | 🌐 Visit Website | 📚 Read Blog | 𝕏 Follow on X

Features

• Clean Interface: A distraction-free UI to help you quickly find and manage your bookmarks.
• Advanced tagging system: Organize bookmarks with colored nested tags. Pin important tags at the top for quick access.
• Browser bookmarklet: Save bookmarks from any desktop or mobile browser without installing any extensions.
• Lightweight and swift: Built with efficiency in mind, Faved loads fast and runs with minimal resource usage.
• One-click migration from Pocket: easily move your saved links, tags, collections and notes from Pocket by uploading the exported ZIP file.
• Open Source: The code is open for you to inspect, modify, and contribute to.

Requirements

• Docker

Installation

1. Pull the latest stable image from Docker Hub

docker pull denho/faved

2. Start the Docker container

docker run -d --name faved -p 8080:80 -v faved-data:/var/www/html/storage denho/faved

This command will:

• Run the container in the background (-d).
• Name the container faved (--name faved).
• Map port 8080 on your host to port 80 inside the container (-p 8080:80). You can change 8080 to any port you prefer.
• Create and mount a named volume called faved-data to application storage directory inside the container (-v faved-data:/var/www/html/storage).

3. Set up database

Once the container is running, you can access the Faved application in your web browser at http://localhost:8080.

The first time you visit, you'll be prompted to set up the database. Just click "Initialize Database" to proceed and finish the installation.

Using the Bookmarklet

1. Navigate to Bookmarklet section in the application Settings.
2. Look for the bookmarklet link "Add to Faved".
3. Drag the bookmarklet link to your browser's bookmarks bar.
4. When browsing the web, click the bookmarklet on any page you want to save.
5. The form to add the web page to Faved will open.
6. Add tags and notes as desired, then save.

Project Structure

• /controllers: Application controllers
• /frontend: React frontend source files
• /framework: Core framework components
• /models: Data models
• /public: Web-accessible files
• /storage: Database storage
• /utils: Utility classes
• /views: HTML templates

License

This project is licensed under the MIT License.

Credits

Faved uses only open source packages:

• React, Tailwind, Shadcn UI and Vite for the frontend.
• PHP 8, SQLite and Apache for the backend.