Skip to content

A minimal local-first p2p web browser: access, communicate, and publish offline.

License

Notifications You must be signed in to change notification settings

p2plabsxyz/peersky-browser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Peersky Browser

platform Release License

💻 Download | 🌐 Website

🛠 Development

  • Install dependencies
npm install
  • Start the app
npm start
  • Build After development of the browser, run the following command. This will create a production build.
npm run build
# For Intel and M1 macs

Now, the build folder will appear in the root directory.

npm run build-all
# For macOS, Linux, and Windows

🚧 Roadmap

Please note that the following roadmap list is in random order, and these items represent high-priority tasks.

  • Browser navigation:

    • Back
    • Forward
    • Reload
    • Home page (peersky://home)
  • IPFS protocol handler:

    • Run a local IPFS node
    • ipfs:// / ipns:// native URLs support
    • Directory listings support
    • Helia integration

      JS-IPFS is deprecated: js-IPFS has been superseded by Helia

  • Experiments:

    • peersky://upload
      • Upload files / directories
      • Publish blogs / websites
    • Peersky://analytics (peerDiscovery)
      • Fetch IPs from the DHT and count them as clicks, with regional sorting (visuals)
    • Peersky://chat (libp2p/webRTC)
      • Chat with connected peers on the network
  • Auto-updater (electron’s autoUpdater):

    • Download and install the latest release from Github automatically
  • QR Code generator:

    • An option to generate QR Code for every page in the URL prompt
  • Context menu:

    • Back / forward
    • Reload
    • Generate QR code
    • Add to IPFS
  • Browser history:

    • peersky://history
    • Suggestions based on the browser history when typing in URL prompt
  • Bookmarks:

    • An option to add favourite pages in the nav bar (peersky://bookmarks)
  • Keyboard shortcuts:

    • New window
    • Back / Forward
    • Reload
    • Find in page
    • Developer tools
  • Extensions:

📄 Contribute

  • Thanks for your interest in contributing to Peersky Browser. There are many ways you can contribute to the project.
  • To start, take a few minutes to read the "contribution guide".
  • We look forward to your pull requests and / or involvement in our issues page.

⚖️ License

Peersky Browser is licensed under the MIT License.


Don't forget to leave a star ⭐️ ~ twitter