Discover Packages
github.com/crispgm/read-track
command
module
Version:
v0.0.0-...-f83d065
Opens a new window with list of versions in this module.
Published: Apr 20, 2024
License: MIT
Opens a new window with license information.
Imports: 3
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
README
¶
Read Track
A minimal personal reading list inspired by blog post from Thomas Pain .
You may deploy your own Read Track instance and track read from different devices.
Features
Simple API Endpoints with easy-to-setup bookmarklet and iOS shortcut.
Multiple verb support: read, skim, unread, and skip.
Designated for single user with Auth0 login.
Dashboard with statistical data.
Dev
Register an Auth0 account and create an application.
Setup .env
according to .env.example
. Make sure all the env vars are ready.
Run (DB is auto migrated):
script/run.sh
Deploy
We only support fly.io right now. And DB is stored in fly volumes.
Deploy with fly.io
Install fly.io cli:
brew install flyctl
Setup env
inside fly.toml
:
[env]
INSTANCE = "<instance-name>"
PORT = "8080"
MODE = "production"
TIMEZONE = "Asia/Shanghai"
HTTP_PORT = ":8080"
DB_PROVIDER = "sqlite"
DB_NAME = "/data/read-track-production.db"
Setup secrets with fly secrets
:
fly secrets set HTTP_TOKEN="your-secrets"
fly secrets set AUTH0_DOMAIN='YOUR_DOMAIN'
fly secrets set AUTH0_CLIENT_ID='YOUR_CLIENT_ID'
fly secrets set AUTH0_CLIENT_SECRET='YOUR_CLIENT_SECRET'
fly secrets set AUTH0_CALLBACK_URL='http://YOUR_DOMAIN/callback'
fly secrets set AUTH0_USER_ID='YOUR_USER_ID'
Deploy:
fly deploy
License
MIT
Expand ▾
Collapse ▴
Documentation
¶
package main serves read track API
Source Files
¶
Directories
¶
internal
Package app serves
Package model .
Click to show internal directories.
Click to hide internal directories.