Giter Club home page Giter Club logo

bookmark_builder's Introduction

Create Bookmarks for your Github and Bitbucket projects

Your CLI Node.js app for generating bookmarks from GitHub and Bitbucket repositories.

Features

  • Fetch GitHub and Bitbucket repositories using their CLI tools.
  • Generate an index.html bookmark file.
  • Customizable with JSON metadata and custom templates.
  • Standalone executable for Windows 10+ and Linux.

Prerequisites

  • Node.js
  • GitHub CLI (gh)
  • Bitbucket CLI

Installation

Clone the repository and install dependencies:

git clone https://github.com/LarryBattle/bookmark_builder.git
cd bookmark_builder
npm install

Usage

Run the script with:

node create_bookmarks.js --project_id PROJECT_ID --templates=github,bitbucket

For a standalone executable:

./create_bookmarks --project_id PROJECT_ID --templates=github,bitbucket

Build Standalone Executable with pkg

First, install pkg globally:

npm install -g pkg

Then run the following command in your project directory:

pkg create_bookmarks.js --targets node18-win-x64,node18-linux-x64

This will generate executable files for Windows 10+ and Linux.

Custom Templates

To use a custom template, pass the path to the custom template JavaScript file using the --custom_template option.

./create_bookmarks --project_id PROJECT_ID --custom_template=path/to/your/file.js

Contributing

Please read CONTRIBUTING.md (TODO) for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

bookmark_builder's People

Contributors

larrybattle avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.