Notable Links

Introduction

Notable Links is a public platform designed to democratize knowledge sharing. It allows users to share informative links, tag them according to topics, and enhance them with personal notes, memos, or reviews. Every link undergoes admin verification to maintain the quality and credibility of the shared resources. View and click counts for each link offer additional insights into the content's reach and impact.

Main Features 🌟

Link Sharing and Management

• Share and tag informative links for community learning.
• Admin verification for maintaining the quality and credibility of shared resources.
• View and click counts for each shared link.

User Engagement

• Ability to add personal notes or memos to shared links.
• Option for users to write reviews about the links.

Prerequisites

• Bun installed on your system.
• antfu/ni 💡 Use the right package manager.

Usage

1. Clone the Repository

   git clone https://github.com/productsway/notable-links.git

2. Install Dependencies

   bun install

3. Run Dev Locally

   bun run dev

   Open localhost:3000/ with your browser to see the result.

Test

Run Test Locally

bun run test

🚀 Usage with Docker

Before running the application with Docker, make sure you have Docker and Docker Compose installed.

Building the Docker image

docker build -t notable-links

Running with Docker Compose and Traefik

1. Create a network named web if you haven't already:

   docker network create web

2. Start the services:

   docker-compose up

You should now be able to access the application at http://notable-link.local.

Make sure you have added the following to your /etc/hosts file.

127.0.0.1 notable-link.local

Additional Resources

• Bun 1.0 Release Blog
• An Introduction to the Bun JavaScript Runtime
• Elysia - Fast, and friendly Bun web framework

Author

👤 Huynh Duc Dung

• Website: productsway.com
• Twitter: @jellydn
• Github: @jellydn

Show your support

If this guide has been helpful, please give it a ⭐️.