You've already forked hotpocket
BTHLABS-66: Prepping for public release: Take five
AKA "Using Apple reviewers as QA for your project". Thanks, y'all! :)
This commit is contained in:
20
README.md
20
README.md
@@ -1,6 +1,23 @@
|
||||
# HotPocket by BTHLabs
|
||||
|
||||
This repository contains the _HotPocket_ project.
|
||||
Minimal self-hosted bookmarking app :).
|
||||
|
||||
## The what, the why and the ugly
|
||||
|
||||
HotPocket is a minimal self-hosted bookmarking app. It combines a Web
|
||||
application, companion apps, browser extensions to give you a way to quickly
|
||||
save links for later.
|
||||
|
||||
HotPocket came to be to fill in the blank left by Pocket, after Mozilla shut it
|
||||
down. I looked at the existing alternatives and found them either too
|
||||
feature-rich, too involved to self-host or otherwise not to my liking. So I
|
||||
decided to sit down and build something for myself.
|
||||
|
||||
With the what and why out of the way, let's talk about the ugly... At its core
|
||||
HotPocket is a personal project. I built it by myself and for myself. It may
|
||||
or may not fit your needs. If it does, happy saving!
|
||||
|
||||
If you're feeling up for an adventure, continue reading below :).
|
||||
|
||||
## Development setup
|
||||
|
||||
@@ -128,6 +145,7 @@ that can be used to configure the services.
|
||||
| `HOTPOCKET_BACKEND_RUN_MIGRATIONS` | `false` or `true` | Set to `true` to run database muigrations when the container starts. |
|
||||
| `HOTPOCKET_BACKEND_INITIAL_ACCOUNT_USERNAME` | N/A | Username for the initial account. |
|
||||
| `HOTPOCKET_BACKEND_INITIAL_ACCOUNT_PASSWORD` | N/A | Password for the initial account. |
|
||||
| `HOTPOCKET_BACKEND_OPERATOR_EMAIL` | N/A | Instance operator's e-mail. Used to display extra language on login page. |
|
||||
|
||||
**Env and App settings**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user