Skip to content

synthomat/myuri

Repository files navigation

Myuri

Myuri is a simple bookmark manager.

CI

It allows bookmarking websites using a convenient bookmarklet.

Version 0.5

Kick Start with Docker Compose

The most convenient way of starting the software is by using docker-compose

$ curl -OJ https://raw.githubusercontent.com/synthomat/myuri/main/docker-compose.yml
$ docker compose up -d

Then open browser at http://localhost:3000/

Roadmap

  • Auto generate cookie secret and store in database
  • Fetch site information in the background
  • Check link status regularly (e.g. for 404)

Installation

Prerequisites

  • JRE 8+
  • Clojure CLI and tools
  • PostgreSQL 8+
  • Docker and Docker-Compose if you wish to use that stack

Download from https://github.com/synthomat/myuri

Usage

$ clj -T:build uber

This will produce a self contained uberjar in the target/ directory.

Run that uberjar:

$ DATABASE_URL=jdbc:postgresql://localhost/myuri java -jar target/myuri-0.9.jar
Environment Default Example Explanation
DATABASE_URL jdbc:postgresql://localhost:5432/myuri jdbc:postgresql://localhost:5432/myuri Database connection string
COOKIE_SECRET JS9D2GG6ytgOLx06 PAWXt2maWB8bpBCR 16-bytes encryption key for the Cookie Session store. This is critical – please change the default!
PORT 3000 3000 Web App HTTP Port

Launch with Docker Compose

$ docker compose up -d  

Build Docker image

$ docker build -t myuri:0.9 .

Dev environment

Launch dev environment in the REPL

$ DATABASE_URL=jdbc:postgresql://localhost/myuri clj -A:dev

Then you can use these commands to launch, restart or stop the running application

user=> (go)     ; launches application
user=> (reset)  ; re-starts application
user=> (stop)   ; stops application

Running tests

$ clj -T:build test

License

Copyright © 2022–2024 Synthomat

Distributed under the ISC License