diff --git a/README.md b/README.md
index 20db62b..c2039e1 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,6 @@ LinkWarden
A place for your useful links.
-
@@ -13,16 +12,18 @@ LinkWarden
-[Demo](https://linkwarden.netlify.app/) | [Intro & Motivation](https://github.com/Daniel31x13/link-warden#intro--motivation) | [Features](https://github.com/Daniel31x13/link-warden#features) | [Setup](https://github.com/Daniel31x13/link-warden#setup) | [Development](https://github.com/Daniel31x13/link-warden#linkwarden-development)
+[Demo](https://linkwarden.netlify.app/) | [Intro & Motivation](https://github.com/Daniel31x13/link-warden#intro--motivation) | [Features](https://github.com/Daniel31x13/link-warden#features) | [Roadmap](https://github.com/Daniel31x13/link-warden/wiki#project-roadmap) | [Setup](https://github.com/Daniel31x13/link-warden#setup) | [Development](https://github.com/Daniel31x13/link-warden#linkwarden-development)
## Intro & Motivation
+
**LinkWarden is a self-hosted, open-source bookmark + archive manager to collect, and save websites for offline use.**
The objective is to have a self-hosted place to keep useful links in one place, and since useful links can go away (see the inevitability of [Link Rot](https://www.howtogeek.com/786227/what-is-link-rot-and-how-does-it-threaten-the-web/)), LinkWarden also saves a copy of the link as screenshot and PDF.
## Features
+
- [x] Sleek, minimalist design.
- [x] Save a copy of each link as screenshot and PDF.
- [x] Dark/Light mode support.
@@ -34,7 +35,9 @@ The objective is to have a self-hosted place to keep useful links in one place,
**Also take a look at our planned features in the [project roadmap section](https://github.com/Daniel31x13/link-warden/wiki#project-roadmap).**
## Setup
+
### Linux/MacOS
+
1. Make sure your MongoDB database and collection is up and running.
2. Edit [/src/config.js](src/config.js) accordingly.
@@ -44,6 +47,7 @@ The objective is to have a self-hosted place to keep useful links in one place,
4. Run `npm start` to start the application.
## LinkWarden Development
+
All contributions are welcomed! Please take a look at [how to contribute](.github/CONTRIBUTING.md).
> **For questions/help, feature requests and bug reports please create an [issue](https://github.com/Daniel31x13/link-warden/issues) (please use the right lable).**
diff --git a/api/modules/getData.js b/api/modules/getData.js
index dc0476e..3626753 100644
--- a/api/modules/getData.js
+++ b/api/modules/getData.js
@@ -1,17 +1,18 @@
-const puppeteer = require('puppeteer');
-const { PuppeteerBlocker } = require('@cliqz/adblocker-puppeteer');
-const fetch = require('cross-fetch');
-const config = require('../../src/config.js');
-const fs = require('fs');
+const puppeteer = require("puppeteer");
+const { PuppeteerBlocker } = require("@cliqz/adblocker-puppeteer");
+const fetch = require("cross-fetch");
+const config = require("../../src/config.js");
+const fs = require("fs");
-const screenshotDirectory = config.API.STORAGE_LOCATION + '/LinkWarden/screenshot\'s/';
-const pdfDirectory = config.API.STORAGE_LOCATION + '/LinkWarden/pdf\'s/';
+const screenshotDirectory =
+ config.API.STORAGE_LOCATION + "/LinkWarden/screenshot's/";
+const pdfDirectory = config.API.STORAGE_LOCATION + "/LinkWarden/pdf's/";
-if (!fs.existsSync(screenshotDirectory)){
+if (!fs.existsSync(screenshotDirectory)) {
fs.mkdirSync(screenshotDirectory, { recursive: true });
}
-if (!fs.existsSync(pdfDirectory)){
+if (!fs.existsSync(pdfDirectory)) {
fs.mkdirSync(pdfDirectory, { recursive: true });
}
@@ -22,11 +23,14 @@ module.exports = async (link, id) => {
await PuppeteerBlocker.fromPrebuiltAdsAndTracking(fetch).then((blocker) => {
blocker.enableBlockingInPage(page);
});
-
- await page.goto(link, { waitUntil: 'load', timeout: 0 });
- await page.screenshot({ path: screenshotDirectory + id + '.png', fullPage: true});
- await page.pdf({ path: pdfDirectory + id + '.pdf', format: 'a4' });
+ await page.goto(link, { waitUntil: "load", timeout: 0 });
+
+ await page.screenshot({
+ path: screenshotDirectory + id + ".png",
+ fullPage: true,
+ });
+ await page.pdf({ path: pdfDirectory + id + ".pdf", format: "a4" });
await browser.close();
-}
+};
diff --git a/api/pages/404.html b/api/pages/404.html
index 7cd5206..5348452 100644
--- a/api/pages/404.html
+++ b/api/pages/404.html
@@ -1,15 +1,20 @@
-