/Bookmarks-App

A "ranked" bookmarks managing application. A personal project to tinker with and use in my free time.

Primary LanguageTypeScript

🔖 Max' Bookmarks App

A "ranked" bookmarks managing application. A personal project to tinker with and use in my free time.

✨ Features

  • 🔎 Fuzzy search
  • 🏷️ Tagging
  • ✏️ Editing
  • ⚔️ Sorting of bookmarks via 1 VS. 1 voting (using Wilson Score)
  • 📁 Multiple "database" tables
  • 🗄️ Automatic backup on boot
  • 📊 "Statistics"
  • 🎨 Random UI color

🔨 Tech

🖼️ Front-End

⚙️ Back-End

▶️ How To Use

npm install
npm start

Uses concurrently to run both the client and server in parallel.

📄 Adding bookmarks

Currently the only way to add bookmarks is to import via some JSON in the following format:

[
	{
		"title": "GitHub",
		"url": "https://github.com"
	},
	{
		"title": "Google",
		"url": "https://google.com"
	}
]

📁 Adding tables

Create a new JSON file in /server/database/tables and restart the server. See /server/database/tables/example.json for an example. The application uses the name of the file as the title of the table.

Make sure to restart the server after adding a new table.

Here's a minimal example:

{
	"emoji": "🔖",
	"bookmarks": [],
	"votes": [],
	"categories": []
}