damus.io

damus.io website
git clone git://jb55.com/damus.io
Log | Files | Refs | README | LICENSE

README.md (2179B)

      1 # Damus Web 
      2 
      3 Here lies the code for the Damus web app, a client for the Nostr protocol. The
      4 goal of this client is to be a better version of Twitter, but not to reproduce
      5 all of it's functionality.
      6 
      7 [Issue Tracker](https://todo.sr.ht/~tomtom/damus-web-issues)
      8 
      9 ## Roadmap
     10 
     11 Here is what is confirmed for development.
     12 
     13  - [ ] Share event
     14  - [ ] Profile view (with ability to follow user)
     15  - [ ] Edit metadata (from profile view)
     16  - [ ] Global timeline view
     17  - [ ] Notifications view
     18  - [ ] Settings view (with ability to configure relays)
     19  - [ ] Multiple reaction picker
     20  - [ ] Direct Messages (subject to discussion)
     21 
     22 ## Contribution Guide
     23 
     24 There are rules to contributing to this client. Please ensure you read them 
     25 before making changes and supplying patch notes.
     26 
     27  - No transpilers. All source code should work out of the box.
     28  - Keep source code organised. Refer to the folder structure. If you have a
     29    question, ask it.
     30  - Do not include your personal tools in the source code. Use your own scripts
     31    outside of the project. This does not include build tools such as Make.
     32  - Use tabs & write JS with snake_case. End of discussion.
     33  - Do not include binary files.
     34  - No NPM (and kin) environments. If you need a file from an external resource
     35    mark the location in the "sources" file and add it to the repo.
     36  - No frameworks. Learn the browser tools and write good code. 
     37  - No experimental browser APIs.
     38  - Do not write animations in JavaScript, CSS only. Keep them short and snappy.
     39    Animations should not be a forefront, but an enjoyable addition.
     40  - All new & modified code should be properly documented.
     41  - Source code should be readable in the browser.
     42 
     43 These rules are subject to discussion.
     44 
     45 ## Style Guide
     46 
     47 TODO Write about the style guide.
     48 
     49 ## Terminology
     50 
     51  * Sign Out  - Not "log out", "logout", "log off", etc.
     52  * Sign In   - Not "login", "log in", "signin", "sign-in", etc.
     53  * Share     - Not "boosted", "retweeted", "repost", etc.
     54  * Send      - Not "tweet", "toot", "post", etc.
     55  * Link      - Not "share".
     56 
     57 ## Known Issues 
     58 
     59  * You cannot send events when running from an IP address that is not secure. 
     60    Work arounds are not known at this time.
     61 
     62