linkdash's Introduction

Linkdash

Generate a handy dashboard of links in seconds.

Demo

Visit https://linkdash.now.sh or try it locally!

npx linkdash --host https://linkdash.now.sh/api/demo-config

Why?

On a personal level, you might want a quick way to ~~build~~ browse through your important links.

On a professional team level, you might want a stored and filterable list of predefined things to do.

Usage

[yarn add/npm i] --dev linkdash

# Print the help menu
[yarn/npx] linkdash --help

# Create a config file
[yarn/npx] linkdash --init

# Create a dashboard and open in the browser
[yarn/npx] linkdash

The config

// linkdash.config.js
// notice how this is async - you may go crazy and do promise-based tasks here.

module.exports = async () => {
  return {
    title: "Welcome to my linkdash!",

    // a static list of urls to build the linkdash list from
    urls: [
      {
        title: "Visit Github",
        href: "https://github.com",
        group: "Site",

        // optional attributes
        keywords: "additional searchable text to improve searchability",
        id: "generated_id_to_tag_href_target_names",
        isBookmarked: false, // bookmarks the link by default
      },
    ],
    // [OR]
    // specifiy a host to grab the config from
    // host: "https://linkdash.now.sh/api/demo-config",

    disableOpen: false,
    output: "./linkdash.html",
    htmlHead: `
    <meta name="robots" content="noindex" />
    `.trim(),
    // automatically opens the menu
    enableAutoMenu: false,
  };
};

When serving a configuration via the host option, the json response needs to match this shape: ILinkdashHostConfig. Example here: https://linkdash.now.sh/api/demo-config.

Beyond static html

Check out the examples folder to see how linkdash can be used for cases such as running your own server (controlling the output) and using it as a personal deployment companion via git-hooks.

Under the hood

Linkdash simply swaps the contents of a prebuilt html file with your config. Check out the package.json to see the four depedencies it installs!

Happy customers

I never thought I'd never write another personal dashboard.

Snape Livingston

Other applications

Always finding yourself trying to remember things to do after a git push or server deploy? Use linkdash along-side githooks.
Smart url schemas exist everywhere, from mailto:, to tel: to app-specific calls like skype:, spotify: and slack:. Get creative!
If security and collaboration is required, you may utilise linkdash's buildTemplate helper in your favourite http kernel (express, http) or serverless function. That way, you can decide which authorization approach to secure your links dashboard with.
Feel free to fork to customise the html for your needs. (webpack / preact / ts)

Future plans

[ ] Add manifest.json capabilities so the file can be installed in mobile devices.

[ ] Add a Google Sheets example

linkdash's People

Stargazers

Watchers

linkdash's Issues

Error: Cannot read property '__k' of null

Steps to reproduce

Run npx linkdash --host https://linkdash.now.sh/api/demo-config
Created file will be opened in the browser
It just shows a white page and the following error in the browser console:

It works if I use the previous version 0.0.5: npx [email protected] --host https://...

Environment

Browsers: Chrome, Safari, Brave
Node: v14.15.1
NPM: 6.14.8

Browser New Tab Extension?

Hi there, just wondering if there's been thought about turning this into a browser extension? It would be pretty helpful if every time a new tab is opened I can jump to my Linkdash list immediately.

Or even better, somehow incorporate it as part of the address bar?

Support CRUD?

Hi! First of all, this project looks really nice (I've been trying for a year to basically do the same thing that this project solves using a bunch of trello boards, to little success).

Now, I know that config.js is just an async function that takes no input and returns an object asynchronously, and my first thought was that I could maybe get this to support adding/editing/removing stuff across multiple devices using mongodb as a backend.

However, I can't do this currently because:

There's no interface nor API for adding/removing/editing links
The config function doesn't have any parameters, so there is no way of knowing who is calling the API, meaning that if you have any instance public, everyone sees the same thing and have the same permissions

As a backend girl, I'd love to help add support for a proper backend but it cannot be done without first addressing the above two issues.

I'd love to hear your thoughts on this.

macouella / linkdash Goto Github PK