From 8a6a07a38bfc3354a58f98d151afc66a9edd6db5 Mon Sep 17 00:00:00 2001 From: styppo Date: Sun, 1 Jan 2023 23:21:32 +0000 Subject: [PATCH] Branding --- LICENSE | 2 +- README.md | 9 +++--- quasar.config.js | 6 ---- src/components/BaseInformation.vue | 46 +++++++++++++++--------------- src/components/BaseIssues.vue | 42 +++++++++++++-------------- 5 files changed, 50 insertions(+), 55 deletions(-) diff --git a/LICENSE b/LICENSE index ae98c5f..e78add1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2021-2022 Ben Arc, Branle and Astral developers +Copyright (c) 2021-2022 Ben Arc, Branle, Astral and Hamstr developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index eb36d5b..cf126dd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# astral +# Hamstr -[astral](https://astral.ninja) is a web client for interacting with [Nostr](https://github.com/fiatjaf/nostr), a protocol that attempts to make decentralized social media a reality. astral began as a fork of [Branle](https://github.com/fiatjaf/branle). +[Hamstr](https://hamstr.to) is a twitter-style [Nostr](https://github.com/fiatjaf/nostr) web client. +It is a fork of [astral](https://github.com/monlovesmango/astral), which itself started as a fork of [branle](https://github.com/fiatjaf/branle). ## Install the dependencies ```bash @@ -47,12 +48,12 @@ quasar build ### Build the docker image (uses PWA mode): ```bash -docker build -t astral . +docker build -t hamstr . ``` ### Run the container: ```bash -docker run -d -p 8080:8000 --name astral astral +docker run -d -p 8080:8000 --name hamstr hamstr ``` and connect to 'http://localhost:8080/' diff --git a/quasar.config.js b/quasar.config.js index b4d1b0f..cf0c413 100644 --- a/quasar.config.js +++ b/quasar.config.js @@ -108,12 +108,6 @@ module.exports = configure(function (ctx) { 'Cross-Origin-Opener-Policy': 'same-origin', 'Cross-Origin-Embedder-Policy': 'require-corp' }, - // proxy: { - // '/api': { - // target: 'https://astral.ninja', - // secure: false, - // } - // } }, // https://v2.quasar.dev/quasar-cli-webpack/quasar-config-js#Property%3A-framework diff --git a/src/components/BaseInformation.vue b/src/components/BaseInformation.vue index e13e4bc..cb937c0 100644 --- a/src/components/BaseInformation.vue +++ b/src/components/BaseInformation.vue @@ -23,7 +23,7 @@
  • any client can be used with any relay, meaning users can choose their relays and client independently

    • - astral is a client for Nostr. while astral is implementing a social media usecase of Nostr, the possibilities of Nostr are endless. + Hamstr is a client for Nostr. while Hamstr is implementing a social media usecase of Nostr, the possibilities of Nostr are endless. Jester is a beta peer to peer chess client implemented over Nostr.

    @@ -97,7 +97,7 @@ function, meaning:

    @@ -237,12 +237,12 @@ header-class='items-center' >
    1. hit GENERATE KEYS button below in the key input
      2. -
    2. proceed to how to use astral? section below
      3. +
    3. proceed to how to use Hamstr? section below
     @@ -268,8 +268,8 @@
  • open the getAlby extension options page (usually in dropdown when clicking on extension's icon at the top of your broswer)
  • hit the Settings tab
  • scroll down to the Nostr section and hit Generate (or if you already have a private key enter it)
    • -
  • refresh astral.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • -
  • proceed to how to use astral? section below
    • +
  • refresh Hamstr.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • +
  • proceed to how to use Hamstr? section below
    • @@ -289,8 +289,8 @@
  • install nos2x browser extension
  • open the nos2x extension options page (usually in dropdown when clicking on extension's icon at the top of your broswer)
  • hit generate button (or if you already have a private key enter it and hit save)
    • -
  • refresh astral.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • -
  • proceed to how to use astral? section below
    • +
  • refresh Hamstr.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • +
  • proceed to how to use Hamstr? section below
    • @@ -309,7 +309,7 @@
    1. open terminal
    2. enter the command 
      openssl rand -hex 32
      3. -
    3. proceed to how to use astral? section below
      4. +
    4. proceed to how to use Hamstr? section below
    @@ -325,7 +325,7 @@ header-class='items-center' >
      @@ -337,26 +337,26 @@ choose bootstrap relays (optional) this section will only appear once a valid key has been entered. if you are using a brand new key you don't need to worry about this. if you are using an existing key and don't typically use any of the selected - relays, make sure to include a relay you typically use or astral may not be able to find your user. - the bootstrap relays are NOT used as your user's relay list, astral only uses these to find your + relays, make sure to include a relay you typically use or Hamstr may not be able to find your user. + the bootstrap relays are NOT used as your user's relay list, Hamstr only uses these to find your user's information and settings when loading your Nostr account.
    1. - hit PROCEED astral will login and attempt to find your user information. please + hit PROCEED Hamstr will login and attempt to find your user information. please be patient as it can take a few minutes to completely sync with Nostr relays.
    2. BACK UP YOUR KEYS!!! once you are taken to the settings page you should get a popup displaying your Nostr keys. make sure to make a backup of your Nostr keys and keep it somewhere safe. if you lose your Nostr keys you lose access to your Nostr user identity. there is no - astral customer service to reset your password. + Hamstr customer service to reset your password.
    3. edit settings hit the EDIT button for which ever section you would like to edit.
      • profile saving this section will broadcast your updated user profile to the - Nostr relays (if you have never set your relays on Nostr, astral will use astral's default relay + Nostr relays (if you have never set your relays on Nostr, Hamstr will use Hamstr's default relay list to set and broadcast your set Nostr relays at the same time). all fields in the profile are completely optional, you don't need to set a profile at all to use Nostr.
          @@ -369,7 +369,7 @@
        • -
      • preferences saving this section will update the look of astral for this browser. +
      • preferences saving this section will update the look of Hamstr for this browser. this section is not synced to Nostr.
      • relays saving this section will broadcast your updated relay list to the Nostr relays.
        • diff --git a/src/components/BaseIssues.vue b/src/components/BaseIssues.vue index 71b8763..2610bfd 100644 --- a/src/components/BaseIssues.vue +++ b/src/components/BaseIssues.vue @@ -23,7 +23,7 @@
      • any client can be used with any relay, meaning users can choose their relays and client independently

      - astral is a client for Nostr. while astral is implementing a social media usecase of Nostr, the possibilities of Nostr are endless. + Hamstr is a client for Nostr. while Hamstr is implementing a social media usecase of Nostr, the possibilities of Nostr are endless. Jester is a beta peer to peer chess client implemented over Nostr.

      @@ -97,7 +97,7 @@ function, meaning:
      • your public key can be calculated from your private - key - which is why you only need to enter your private key for astral to + key - which is why you only need to enter your private key for Hamstr to know your public key
      • your private key cannot be calculated from your public key - which is why you can freely share your public key without compromising your @@ -118,8 +118,8 @@ public key) and 'nsec' (for Nostr secret key) format that Damus - uses is preferable over the hex format that astral uses because there is a visual - indicator preventing the user from mixing up their public and private key. astral + uses is preferable over the hex format that Hamstr uses because there is a visual + indicator preventing the user from mixing up their public and private key. Hamstr will adopt this format in the future.

        @@ -142,8 +142,8 @@
      • not store your private key
      • not have any vulnerabilities that a bad actor can exploit to steal your private key
    - while I can promise you that astral does not store your private key (it is stored locally in your - browser and is NEVER sent to back to astral) and that I am doing my best to prevent vulnerabilities, + while I can promise you that Hamstr does not store your private key (it is stored locally in your + browser and is NEVER sent to back to Hamstr) and that I am doing my best to prevent vulnerabilities, it is still recommeneded that you DO NOT TRUST ME.

    @@ -184,7 +184,7 @@

  • if you are on a desktop device the recommeneded option will be using a browser extension like getAlby or nos2x. (see why shouldn't I enter my private key? section above)
    • -
  • if you are on a mobile device the easiest option will be using astral
    • +
  • if you are on a mobile device the easiest option will be using Hamstr
  • if you are a technical user who is concerned about key generation security you can try the local option

    • @@ -205,12 +205,12 @@ header-class='items-center' >
    1. hit GENERATE KEYS button below in the key input
      2. -
    2. proceed to how to use astral? section below
      3. +
    3. proceed to how to use Hamstr? section below
     @@ -230,8 +230,8 @@
  • install nos2x browser extension
  • open the nos2x extension options page (usually in dropdown when clicking on extension's icon at the top of your broswer)
  • hit generate button
    • -
  • refresh astral.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • -
  • proceed to how to use astral? section below
    • +
  • refresh Hamstr.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • +
  • proceed to how to use Hamstr? section below
    •  @@ -257,8 +257,8 @@
  • open the getAlby extension options page (usually in dropdown when clicking on extension's icon at the top of your broswer)
  • hit the Settings tab
  • scroll down to the Nostr section and hit Generate
    • -
  • refresh astral.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • -
  • proceed to how to use astral? section below
    • +
  • refresh Hamstr.ninja page and hit the USE PUBLIC KEY FROM EXTENSION option that should appear in the key input
    • +
  • proceed to how to use Hamstr? section below
    • @@ -277,7 +277,7 @@
    1. open terminal
    2. enter the command 
      openssl rand -hex 32
      3. -
    3. proceed to how to use astral? section below
      4. +
    4. proceed to how to use Hamstr? section below
    @@ -293,7 +293,7 @@ header-class='items-center' >
      @@ -305,26 +305,26 @@ choose bootstrap relays (optional) this section will only appear once a valid key has been entered. if you are using a brand new key you don't need to worry about this. if you are using an existing key and don't typically use any of the selected - relays, make sure to include a relay you typically use or astral may not be able to find your user. - the bootstrap relays are NOT used as your user's relay list, astral only uses these to find your + relays, make sure to include a relay you typically use or Hamstr may not be able to find your user. + the bootstrap relays are NOT used as your user's relay list, Hamstr only uses these to find your user's information and settings when loading your Nostr account.
    1. - hit PROCEED astral will login and attempt to find your user information. please + hit PROCEED Hamstr will login and attempt to find your user information. please be patient as it can take a few minutes to completely sync with Nostr relays.
    2. BACK UP YOUR KEYS!!! once you are taken to the settings page you should get a popup displaying your Nostr keys. make sure to make a backup of your Nostr keys and keep it somewhere safe. if you lose your Nostr keys you lose access to your Nostr user identity. there is no - astral customer service to reset your password. + Hamstr customer service to reset your password.
    3. edit settings hit the EDIT button for which ever section you would like to edit.
      • profile saving this section will broadcast your updated user profile to the - Nostr relays (if you have never set your relays on Nostr, astral will use astral's default relay + Nostr relays (if you have never set your relays on Nostr, Hamstr will use Hamstr's default relay list to set and broadcast your set Nostr relays at the same time). all fields in the profile are completely optional, you don't need to set a profile at all to use Nostr.
          @@ -337,7 +337,7 @@
        • -
      • preferences saving this section will update the look of astral for this browser. +
      • preferences saving this section will update the look of Hamstr for this browser. this section is not synced to Nostr.
      • relays saving this section will broadcast your updated relay list to the Nostr relays.