hyl.st
+78
README.md
+78
README.md
···
1
1
2
+
3
+
# woomarks
4
+
woomarks is an app that let's you save links in your browser storage, no account needed.
5
+
6
+
7
+
8
+
It's only frontend code, no database, backend server needed.
9
+
10
+
11
+
12
+
It also can import/export to csv files or local storage.
13
+
14
+
15
+
## Demos
16
+
#### [Creator's personal boomarks page](https://roberto.fyi/bookmarks/).
17
+
- Saving is closed to the public.
18
+
- Saved links are visible to the public, as they are loaded from a csv file in the server.
19
+
20
+
#### [woomarks public app](https://woomarks.com).
21
+
- Saving is open to the public.
22
+
- The saved links are private and saved in the browser local storage of the users.
23
+
24
+
## Install
25
+
26
+
#### BASIC INSTALL
27
+
- Copy the contents of this repository to an online directory. That's all. You can start saving links.
28
+
29
+
30
+
#### HIDE SAVE BUTTON
31
+
- If you are using this for your personal use (you don't want anyone else saving on your page), you can uncomment this line in **script.js** file
32
+
and add the code you want here AND as a variable in your browser's local storage.
33
+
34
+
`
35
+
// const appcode = "notsosecretcode";
36
+
`
37
+
38
+
39
+
40
+
#### SHOWCASE YOUR LINKS
41
+
- If you want to showcase your saved links, update the **mybookmarks.csv** file
42
+
43
+
#### IMPORT FROM POCKET
44
+
- Go to this Pocket page to export your links
45
+
46
+
**Option 1** (If you want your links public)
47
+
- Replace the mybookmarks.csv witha the content of your Pocket csv file.
48
+
49
+
**Option 2** (If you want your links saved on your browser's local storage)
50
+
- Add > Bulk Transfer > Paste the contents.
51
+
52
+
## Features
53
+
- Add/Delete links
54
+
- Search
55
+
- Tags
56
+
- Bookmarklet (useful for a 2-click-save)
57
+
- Data reads from:
58
+
- csv file in server (these links are public)
59
+
- local storage in browser (these links are visible just for the user)
60
+
- Local storage saving.
61
+
- Import to local storage from csv file
62
+
- Export to csv from local storage.
63
+
- Export to csv from csv file (useful when links are "deleted" using the app and just hidden using a local storage blacklist).
64
+
- Export to csv from both places.
65
+
- No external libraries.
66
+
- Vanilla css code.
67
+
- Vanilla js code.
68
+
69
+
## Design
70
+
This design is inspired by Pocket's UI, which was very good for showing a list of articles to read later. Native bookmarking feels more utilitarian, suited for recurrent links, woomarks is more suited for read later links.
71
+
72
+
## Philosophy
73
+
I had all my bookmarks in Pocket and it's shutting down. Same thing happened to del.icio.us. So I decided to keep the web cool and decentralized and make this little thing. The code is open and you can use it on your own website forever.
74
+
75
+
## License
76
+
Do whatever you want with this, personal or commercial. No warranties are given.
77
+
78
+
Attribution required in a footer link, legible size and colour, with the text "Made with woomarks" and a link to `https://github.com/earlyriser/woomarks`.
79
+
"Based on woomarks" is also a valid wording if substantial change was done.
screenshot.png
screenshot.png
This is a binary file and will not be displayed.
screenshot_appcode.png
screenshot_appcode.png
This is a binary file and will not be displayed.
+1
script.js
+1
script.js
···
2
2
const LOCAL_GLOW = true; // adds a glow to differentiate items stored locally in the browser from those stored in csv file
3
3
const EXPORT = "all"; // choose export type "all", "csv", "local"
4
4
// const appcode = "notsosecretcode";
5
+
5
6
const MAX_CHARS_PER_LINE = 15;
6
7
const MAX_LINES = 4;
7
8
const EST_CHAR_WIDTH = 0.6; // em