Skip to content

getting_started

Jump to bottom
Robert C. Martin edited this page Jul 20, 2022 · 34 revisions

Getting Started

(optional) Cloning this repository.

  • You will need Clojure and Leiningen.
  • Edit the project.clj file. Find the :java-cmd line and change the path to your Java 17 implementation. You may be able to delete this line if you have java17 normally installed.
  • To run the tests: lein spec
  • To run the tests with an auto-runner: lein spec -a

Setup

The first step is to download the application. You can do that by cloning this repository, or you can download a standalone jar file from https://www.dropbox.com/s/8r23ufbcyho5jwx/more-speech-0.1.0-SNAPSHOT-standalone.jar?dl=0.

The next step is to run the application. If you cloned the repository, and you can do that with lein run. If you downloaded the jar file then just type java -jar more-speech-0.1.0-SNAPSHOT-standalone.jar.

The first time you run the application it will do most of the setup for you. The main window will pop up, and if you click the all tab you'll see some messages. more-speech has generated a private and public key for you, and given you a temporary user name. I recommend you quit now and edit private/keys file to put a better name into your profile. If you like you can add the about and picture too. And if you already have public and private keys from some other source, you can replace the automatically generated ones.

There should now be several files in the private directory. You may wish to edit some of them.

  • private/keys Your personal profile. .
  • private/nicknames User nicknames. -- DEPRECATED --
  • private/profiles User profiles.
  • private/read-event-ids Ids of messages you've read.
  • private/relays The nostr relays you read from and write to.
  • private/tabs-list The tabs you want, and the filters they employ.
  • private/migration Contains the migration level (version number) of the data files. Don't touch!
  • private/messages Is a directory containing daily message files. The last N of these are read in by more-speech on startup so that N days of messages are displayed in your tabs. N defaults to 10 but can be configured in the more-speech/config file.
Clone this wiki locally