minelminel / linkr

a simple way to manage, organize, and share links

Linkr 📎

Linkr is a simple way to save, organize, and share web pages. Links are separated into user-defined buckets, which can be as broad or narrow as desired. multiple buckets can be grouped into a tub. A sample structure is outlined below.

├── Search Engines
│   ├── Bing
│   ├── DuckDuckGo
│   ├── Google
│   └── Yahoo
└── Social
    ├── Photos
    │   ├── Flickr
    │   └── Instagram
    ├── Places
    │   ├── Facebook
    │   └── FourSquare
    └── Work
        └── LinkedIn

Why use Linkr instead of your browser's built-in Bookmarks? Linkr securely stores all your pages in the cloud and won't require you to sync your browser by linking it with your email account. In addition, Linkr allows you to easily share any bucket with a single click--letting you pass them along to coworkers, family, and friends--who can then easily view and access the links through a simple interface.

---

Table of Contents

• Getting Started
  • Quick Start
  • Docker
  • Deployment
• User Guide
  • Terminology
    • Tub
    • Bucket
    • Link
    • Tag
  • Creating Accounts
  • Create a Tub
  • Create a Bucket
  • Adding Links
  • Editing
  • Sharing
    • Tub
    • Bucket
    • Link
    • Collaboration
• Authors
• Acknowledgements

---

Getting Started

Quick Start

Before you begin, make sure you have the lastest version of Python & pip

python --version
>>> Python 3.7.3

pip --version
>>> pip 19.1.1 from /../../pip (Python 3.7)

If necessary, download both with the python-dev package

sudo apt-get update
sudo apt-get install build-essential libssl-dev libffi-dev python-dev

[1] Clone the repository

git clone https://github.com/minelminel/linkr.git
cd linkr

[2] Create virtual environment (optional)

virtualenv -p python3.7 .
source bin/activate

[3] Install dependencies

pip install -r requirements.txt
cd src # BASE_DIR

[4] Initialize database & server

python manage.py makemigrations

python manage.py migrate

python manage.py createsuperuser

python manage.py runserver

[5] View in browser

http://localhost:8000

---

Docker

[1] Make sure you have Docker Desktop & Docker Compose installed

docker --version
docker-compose --version

Docker Desktop can be downloaded by visiting this link

docker-compose can be installed with pip install docker-compose

[2] Build Docker Image

docker build -t linkr:lastest .

[3] Spin Up Container

docker run -p 8000:8000 linkr

convenience script, which runs the previous 2 commands

sh deploy.sh

---

Deployment

[1]

[2]

[3]

---

User Guide

ipsum lorem

---

Authors

ipsum lorem

---

Acknowledgements

ipsum lorem