thePR0M3TH3AN/Archivestr
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/Archivestr.git synced 2025-09-07 14:58:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
7 Commits 1 Branch 0 Tags
c1707d94ef5329d90b6df3ad78cc20589d3b7d72
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Keep Creating Online c1707d94ef update
2025-01-03 22:58:48 -05:00
src
update
2025-01-03 22:58:48 -05:00
.gitattributes
Initial commit
2025-01-03 15:23:50 -05:00
README.md
update
2025-01-03 15:26:01 -05:00

README.md

Archivestr

Archivestr is a Nostr tool for creating, browsing, and broadcasting archives. It provides a seamless way to interact with Nostr archives through a collector interface for creating archives in JSON format and a viewer for browsing archive files.

Features

  • Collector: Collects and archives Nostr data in JSON format. The collector can also broadcast the archives to Nostr relays.
  • Viewer: Loads and browses existing archive files with sorting and detailed views of event metadata and content.

Project Structure

  • index.html: The landing page with navigation links to the collector and viewer tools.
  • collector.html: The interface for collecting and archiving Nostr events.
  • view-archive.html: The interface for browsing archived JSON files.
  • script.js: The logic for interacting with Nostr relays in the collector tool.

Getting Started

Prerequisites

Ensure you have the following installed:

  • A modern web browser (Chrome, Firefox, etc.)
  • Basic knowledge of Nostr events and relays

Installation

  1. Clone the repository: 
    git clone https://github.com/PR0M3TH3AN/Archivestr.git
  2. Navigate to the project directory: 
    cd archivestr
  3. Open index.html in a browser to get started.

Usage

Collector

  1. Navigate to collector.html.
  2. Enter the NPub (public key) and relay URLs to collect data.
  3. Start collecting events, and download the archive as a JSON file.

Viewer

  1. Navigate to view-archive.html.
  2. Load a JSON archive file.
  3. Browse, sort, and view details of the events in the archive.

Development

Feel free to contribute or customize the project:

  1. Modify collector.html or view-archive.html as needed.
  2. Enhance the functionality in script.js.
  3. Update the styling in the <style> sections or move styles to external CSS files.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

GitHub Repository

Visit the GitHub repository for the source code and updates.

Description
Archivestr is a simple Nostr web tool for creating, browsing, and broadcasting archives. It provides a seamless way to interact with Nostr archives through a collector interface for creating archives in JSON format and a viewer for browsing archive files.
archivenostr
Readme 134 KiB
Languages
JavaScript 60.3%
CSS 21.6%
HTML 18.1%