Simple bookmark manager built with Go
Find a file
Felipe Martin 6f19c12c95
Start working on new REST API. Refactor logic in domains. (#497)
* added 404 template

* added auth domain

* added embed file for frontend

* added base config and dependencies

* added basic new http server

* added separated server command

* updated go modules

* removed modd file

* Added shortcut to send internal server error response

* Added JWT support to Auth Domain

* Added JWT support to API

* docs: added comments to response struct

* naming

* inline returns

* updated dependencies

* production logger

* bookmarks endpoint

* reverted old views api path

* frontend for api v1

* proper 404 error (not working atm)

* use response

* removed 404 html

* server error handler

* login and basic auth

* adjusted session duration

* properly retrieve tags

* properly delete bookmark

* cleanup

* archiver domain

* debug routes

* bookmark routes

* expiration by parameter

* move to logrus

* logout

* frontend cache

* updated dependencies

* http: migrated to gin

* linted

* Added version command

* unit tests, docs

* response test utils and tests

* remove logout handler

* auth

* createtag

* improved http test utilities

* assert message equals

* Remove 1.19 from test matrix

* moved api to v1 folder

* docs: contribute docs

* updated makefile

* updated usage docs

* warn in server command

* updaed docs with shiori version command

* Updated documentation

* deps: update
2023-07-17 14:30:18 +01:00
.githooks Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.github Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
docs Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
internal Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
scripts Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
.dockerignore Setup new CI/CD workflows (#365) 2022-02-13 16:38:54 +01:00
.gitignore feat: sqlite migrations (#398) 2022-03-26 08:33:57 +01:00
.golangci.yml Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
.goreleaser.yaml Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
app.json Revert "Restructure build files" 2019-09-26 16:25:19 +07:00
CODE_OF_CONDUCT.md Update links and email addresses 2020-08-06 22:26:59 +02:00
coverage.txt Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
docker-compose.yaml feat: add SHIORI_PG_SSLMODE (#536) 2023-07-09 08:43:26 +02:00
Dockerfile feat: upgrade to go 1.19 (#469) 2022-08-11 14:22:10 +02:00
Dockerfile.compose Remove typo in post-run command (#527) 2022-10-28 09:03:48 +02:00
go.mod Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
go.sum Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
LICENSE Update LICENSE 2019-01-06 17:00:20 +07:00
main.go Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
Makefile Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
Procfile Added Heroku deploy. Fixed go-shiori/shiori#45 2019-09-25 13:45:08 +03:00
README.md docs: add matrix link to readme 2023-07-06 21:47:08 +02:00

Shiori

IC Go Report Card #shiori@libera.chat #shiori-general:matrix.org Containers

Check out our latest Announcements

Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket. You can use it as a command line application or as a web application. This application is distributed as a single binary, which means it can be installed and used easily.

Screenshot

Features

  • Basic bookmarks management i.e. add, edit, delete and search.
  • Import and export bookmarks from and to Netscape Bookmark file.
  • Import bookmarks from Pocket.
  • Simple and clean command line interface.
  • Simple and pretty web interface for those who don't want to use a command line app.
  • Portable, thanks to its single binary format.
  • Support for sqlite3, PostgreSQL and MySQL as its database.
  • Where possible, by default shiori will parse the readable content and create an offline archive of the webpage.
  • [BETA] web extension support for Firefox and Chrome.

Comparison of reader mode and archive mode

Documentation

All documentation is available in the docs folder. If you think there is incomplete or incorrect information, feel free to edit it by submitting a pull request.

License

Shiori is distributed under the terms of the MIT license, which means you can use it and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.