README
¶
Bookmarkey API
Bookmarkey is a convenient bookmarking app that lets you save web pages and add RSS feeds. This project is the backend web server, running PocketBase. Which has been extended and used as framework with some custom business logic
Production
You can visit the site at: https://bookmarkey.app
Run Locally
Install go-task,
To setup the project locally you can do:
git@gitlab.com:bookmarkey/gui.git
cd gui
go mod tidy
# start server locally; on http://localhost:8080
task start
Test Credentials
To login to the integration tests "instance" and update entries for the database do:
task start:test
# go to http://localhost:8080/_/
Then enter these credentials
username: test@bookmarkey.app
password: password11
Related
Here are some related projects:
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
server/bookmarkey
command
Package main starts our web application and configures everything such as logger and sentry
|
Package main starts our web application and configures everything such as logger and sentry |
|
internal
|
|
|
bookmarks
Package bookmarks provides ways to interact with the bookmarks, such as adding a new bookmark
|
Package bookmarks provides ways to interact with the bookmarks, such as adding a new bookmark |
|
collections
Package collections provides ways to interact with the collections, such as checking who owns a collection
|
Package collections provides ways to interact with the collections, such as checking who owns a collection |
|
helpers
Package helpers provides a bunch of common/helper functions such as simplifying testing (reducing boilerplate)
|
Package helpers provides a bunch of common/helper functions such as simplifying testing (reducing boilerplate) |
|
log
Package log provides a logger to the app.
|
Package log provides a logger to the app. |
|
middleware
Package middleware provides different middlewares than can be used by the http transports
|
Package middleware provides different middlewares than can be used by the http transports |
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.