diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index af2e08a..0000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.gitignore b/.gitignore index 30021f0..1fa18c4 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ TODO.bak *.mp4 channels/index.html node_modules +.DS_Store diff --git a/web/Makefile b/web/Makefile index eed71f9..775251c 100644 --- a/web/Makefile +++ b/web/Makefile @@ -11,8 +11,4 @@ emojiregex: fake dist: rsync -avzP ./ charon:/www/damus.io/web/ -distv2: - rsync -avzP ./ charon:/www/damus.io/webv2/ - - .PHONY: fake diff --git a/web/README.md b/web/README.md new file mode 100644 index 0000000..280d0d9 --- /dev/null +++ b/web/README.md @@ -0,0 +1,37 @@ +# Damus PWA + +Here lies the code for the Damus web app, a client for the Nostr protocol. The +goal of this client is to be a better version of Twitter, but not to reproduce +all of it's functionality. + +## Contribution Guide + +There are rules to contributing to this client. Please ensure you read them +before making changes and supplying patch notes. + +1. No transpilers. All source code should work out of the box. +2. Keep source code organised. Refer to the folder structure. If you have a + question, ask it. +3. Do not include your personal tools in the source code. Use your own scripts + outside of the project. This does not include build tools such as Make. +4. Spaces, no tabs. +5. Do not include binary files. +6. No NPM (and kin) environments. If you need a file from an external resource + mark the location in the "sources" file and add it to the repo. +7. Do not write code using experimental browser APIs. +8. Do not write animations in JavaScript, CSS only. Keep them short and snappy. + Animations should not be a forefront, but an enjoyable addition. +9. All new & modified code should be properly documented. +10. Source code should be readable in the browser. + +TODO Write about code style requirements & add number of spaces. + +## Style Guide + +TODO Write about the style guide. + +## Terminology + + * Sign Out - Not log out, logout, log off, etc. + * Sign In - Not Login, Log In, etc. + diff --git a/web/damus.css b/web/css/damus.css similarity index 100% rename from web/damus.css rename to web/css/damus.css diff --git a/web/fontawesome.css b/web/css/fontawesome.css similarity index 100% rename from web/fontawesome.css rename to web/css/fontawesome.css diff --git a/web/styles.css b/web/css/styles.css similarity index 100% rename from web/styles.css rename to web/css/styles.css diff --git a/web/webfonts/fa-brands-400.ttf b/web/css/webfonts/fa-brands-400.ttf similarity index 100% rename from web/webfonts/fa-brands-400.ttf rename to web/css/webfonts/fa-brands-400.ttf diff --git a/web/webfonts/fa-brands-400.woff2 b/web/css/webfonts/fa-brands-400.woff2 similarity index 100% rename from web/webfonts/fa-brands-400.woff2 rename to web/css/webfonts/fa-brands-400.woff2 diff --git a/web/webfonts/fa-regular-400.ttf b/web/css/webfonts/fa-regular-400.ttf similarity index 100% rename from web/webfonts/fa-regular-400.ttf rename to web/css/webfonts/fa-regular-400.ttf diff --git a/web/webfonts/fa-regular-400.woff2 b/web/css/webfonts/fa-regular-400.woff2 similarity index 100% rename from web/webfonts/fa-regular-400.woff2 rename to web/css/webfonts/fa-regular-400.woff2 diff --git a/web/webfonts/fa-solid-900.ttf b/web/css/webfonts/fa-solid-900.ttf similarity index 100% rename from web/webfonts/fa-solid-900.ttf rename to web/css/webfonts/fa-solid-900.ttf diff --git a/web/webfonts/fa-solid-900.woff2 b/web/css/webfonts/fa-solid-900.woff2 similarity index 100% rename from web/webfonts/fa-solid-900.woff2 rename to web/css/webfonts/fa-solid-900.woff2 diff --git a/web/webfonts/fa-v4compatibility.ttf b/web/css/webfonts/fa-v4compatibility.ttf similarity index 100% rename from web/webfonts/fa-v4compatibility.ttf rename to web/css/webfonts/fa-v4compatibility.ttf diff --git a/web/webfonts/fa-v4compatibility.woff2 b/web/css/webfonts/fa-v4compatibility.woff2 similarity index 100% rename from web/webfonts/fa-v4compatibility.woff2 rename to web/css/webfonts/fa-v4compatibility.woff2 diff --git a/web/index.html b/web/index.html index a8e78f2..119bdfe 100644 --- a/web/index.html +++ b/web/index.html @@ -4,72 +4,78 @@