Merge pull request #31 from zer0bin-dev/idk

Author: ThatOneCalculator

.github/ISSUE_TEMPLATE/03_public_instance.md

@@ -16,7 +16,7 @@ What country is the server in:
 
 What server hardware/provider is the server on:
 
-Are you using CloudFlare: 
+Are you using CloudFlare or any Google serives (domain, DNS, etc): 
 
 What version of zer0bin is it running: 
 

.gitignore

@@ -1,4 +1,5 @@
 **/target/
+**/.yarn
 **/node_modules/
 **/dist/
 **/.parcel-cache/

.prettierrc.json

@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the
+    overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+-   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email
+    address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Enforcement Responsibilities
 
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected] or [email protected].
+[email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CODE_OF_CONDUCT.md

@@ -1,8 +1,10 @@
 # Contributing Guidelines
-- Follow the repository structure
-- Commit messages must be descriptive and concise
-- Your code must be formatted with the respective formatter
-    - The frontend must use `prettier` using our config
-    - The backend must use `rustfmt`
-- The frontend must work with `npm`
-- Additional frontend packages must not be considered bloated
+
+-   Follow the repository structure
+-   Commit messages must be descriptive and concise
+-   Your code must be formatted with the formatters we use
+    -   The frontend must use our `prettier` config
+    -   The backend must use `rustfmt`
+-   The frontend must be installed and compiled with `yarn` and `parcel`
+-   Additional frontend packages must not be considered bloated
+-   All commits must follow [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)

CONTRIBUTING.md

@@ -10,13 +10,13 @@
 	<br>
     <p align="center">
 	<a href="https://github.com/zer0bin-dev/zer0bin/stargazers">
-		<img alt="Stargazers" src="https://custom-icon-badges.herokuapp.com/github/stars/zer0bin-dev/zer0bin?style=for-the-badge&logo=star&color=f6c177&logoColor=31748f&labelColor=12101F"></a>
-<!-- 	<a href="https://github.com/zer0bin-dev/zer0bin/releases/latest">
-		<img alt="Releases" src="https://img.shields.io/github/release/zer0bin-dev/zer0bin?style=for-the-badge&logo=github&color=31748f&logoColor=ebbcba&labelColor=12101F"/></a> -->
+		<img alt="Stargazers" src="https://custom-icon-badges.herokuapp.com/github/stars/zer0bin-dev/zer0bin?style=for-the-badge&logo=star&color=f6c177&logoColor=31748f&labelColor=191724"></a>
+ 	<a href="https://github.com/zer0bin-dev/zer0bin/releases/latest">
+		<img alt="Releases" src="https://img.shields.io/github/release/zer0bin-dev/zer0bin?style=for-the-badge&logo=github&color=31748f&logoColor=908caa&labelColor=191724"/></a>
 	<a href="https://github.com/zer0bin-dev/zer0bin/issues">
-		<img alt="Issues" src="https://custom-icon-badges.herokuapp.com/github/issues/zer0bin-dev/zer0bin?style=for-the-badge&logo=issue-opened&color=9ccfd8&logoColor=eb6f92&labelColor=12101F"></a>
+		<img alt="Issues" src="https://custom-icon-badges.herokuapp.com/github/issues/zer0bin-dev/zer0bin?style=for-the-badge&logo=issue-opened&color=9ccfd8&logoColor=eb6f92&labelColor=191724"></a>
 	<a href="https://github.com/zer0bin-dev/zer0bin/blob/main/LICENSE">
-		<img alt="License" src="https://custom-icon-badges.herokuapp.com/github/license/zer0bin-dev/zer0bin?style=for-the-badge&logo=law&color=c4a7e7&logoColor=ebbcba&labelColor=12101F"></a>
+		<img alt="License" src="https://custom-icon-badges.herokuapp.com/github/license/zer0bin-dev/zer0bin?style=for-the-badge&logo=law&color=c4a7e7&logoColor=ebbcba&labelColor=191724"></a>
 </p>
     <br>
 </div>
@@ -27,44 +27,45 @@ Submit your public instance [here](https://github.com/Domterion/zer0bin/issues/n
 
 | Website                                        | Expiration | Max paste size | Version | Country |
 | ---------------------------------------------- | ---------- | -------------- | ------- | ------- |
-| zer0b.in (not up yet)                          | 7 days     | 40,000 chars   | vx.x.x  | ?       |
-| [stepbro.voring.me](https://stepbro.voring.me) | 365 days   | 69,000 chars   | v0.6.1  | 🇺🇸 US   |
+| zer0b.in                                       | 7 days     | 40,000 chars   | v1.0.0  | 🇺🇸 USA  |
+| [stepbro.voring.me](https://stepbro.voring.me) | 365 days   | 69,000 chars   | v0.7.1  | 🇺🇸 USA  |
 
 # Technologies used
 
 ### Frontend:
 
-<a href="https://www.typescriptlang.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/TypeScript.svg" height=40/></a> <a href="https://sass-lang.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Sass.svg" height=40/></a> <a href="https://pugjs.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Pug-Dark.svg" height=40/></a> <a href="https://rosepinetheme.com/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953176309444542464/RosePine.svg" height=40/></a> <a href="https://highlightjs.org/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953177926688464936/HLJS.svg" height=40/></a> <a href="https://github.com/ant-design/ant-design-icons"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953181625259266059/AntIcons-Dark.svg" height=40/></a> <a href="https://github.com/idiotWu/smooth-scrollbar"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953564432628322364/SmoothScrollJS.svg" height=40/></a> <a href="https://github.com/loonywizard/js-confetti"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953564432896782416/JSConfetti.svg" height=40/></a> <a href="https://definitelytyped.org/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953567495321710602/DefinitelyTyped.svg" height=40/></a> <a href="https://parceljs.org/"><img src="https://user-images.githubusercontent.com/44733677/158683062-17ac3b62-cacd-4add-babb-1f74f36020d8.svg" height=40/></a> <a href="https://yarnpkg.org"><img src="https://cdn.discordapp.com/attachments/810799100940255260/954823377493852170/Yarn.svg" height=40/></a> <a href="https://transfonter.org"><img src="https://user-images.githubusercontent.com/44733677/159066877-234f68ba-e95c-439d-b5fe-74def49dc762.svg" height=40></a>
+<a href="https://www.typescriptlang.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/TypeScript.svg" height=40/></a> <a href="https://sass-lang.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Sass.svg" height=40/></a> <a href="https://pugjs.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Pug-Dark.svg" height=40/></a> <a href="https://rosepinetheme.com/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953176309444542464/RosePine.svg" height=40/></a> <a href="https://highlightjs.org/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953177926688464936/HLJS.svg" height=40/></a> <a href="https://github.com/ant-design/ant-design-icons"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953181625259266059/AntIcons-Dark.svg" height=40/></a> <a href="https://github.com/idiotWu/smooth-scrollbar"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953564432628322364/SmoothScrollJS.svg" height=40/></a><br><a href="https://atomiks.github.io/tippyjs/"><img src="https://cdn.discordapp.com/attachments/872332549777666078/955624715521769522/Tippy.svg" height=40/></a> <a href="https://github.com/loonywizard/js-confetti"><img src="https://cdn.discordapp.com/attachments/810799100940255260/955609316042362930/JSConfetti.svg" height=40/></a> <a href="https://definitelytyped.org/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953567495321710602/DefinitelyTyped.svg" height=40/></a> <a href="https://parceljs.org/"><img src="https://user-images.githubusercontent.com/44733677/158683062-17ac3b62-cacd-4add-babb-1f74f36020d8.svg" height=40/></a> <a href="https://prettier.io/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953339670538887318/Prettier.svg" height=40/></a> <a href="https://yarnpkg.org"><img src="https://cdn.discordapp.com/attachments/810799100940255260/954823377493852170/Yarn.svg" height=40/></a> <a href="https://transfonter.org"><img src="https://user-images.githubusercontent.com/44733677/159066877-234f68ba-e95c-439d-b5fe-74def49dc762.svg" height=40></a>
 
 ### Backend:
 
 <a href="https://www.rust-lang.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Rust.svg" height=40/></a> <a href="https://actix.rs/"><img src="https://user-images.githubusercontent.com/44733677/158648238-0586f185-4e0c-43bc-b6a9-effd18b3b1ac.svg" height=40/></a> <a href="https://github.com/serde-rs/serde"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953176309964627978/Serde-Dark.svg" height=40/></a> <a href="https://github.com/launchbadge/sqlx"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953176310354673704/SQLX-Dark.svg" height=40/></a> <a href="https://github.com/chronotope/chrono"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953178919169835018/NPM-svg.png" height=40/></a> <a href="https://www.postgresql.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/PostgreSQL-Dark.svg" height=40/></a> <a href="https://github.com/nikolay-govorov/nanoid"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953176309629067354/NanoID-Dark.svg" height=40/></a>
 
 ### Misc:
 
-<a href="https://nginx.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Nginx.svg" height=40/></a> <a href="https://github.com/google/ngx_brotli"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953552981691883520/Brotli.svg" height=40/></a> <a href="https://docker.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Docker.svg" height=40/></a> <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Markdown-Dark.svg" height=40/></a> <a href="https://prettier.io/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/953339670538887318/Prettier.svg" height=40/></a> <a href="https://git-scm.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Git.svg" height=40/></a>
+<a href="https://nginx.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Nginx.svg" height=40/></a> <!-- <a href="https://docker.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Docker.svg" height=40/></a> --> <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Markdown-Dark.svg" height=40/></a> <a href="https://git-scm.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Git.svg" height=40/></a> <a href="https://www.conventionalcommits.org/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/954930714007191582/ConventionalCommits.svg" height=40/></a>
 
 ###### (Sorta) made with [Skill Icons](https://skillicons.dev/)
 
 # API
 
--   **GET** `/api/p/:id` - Get a paste by ID
--   **POST** `/api/p/n` - Post a new paste
--   **GET** `/api/s` - Get stats about the instance
+- **GET** `/api/p/:id` - Get a paste by ID
+- **POST** `/api/p/n` - Post a new paste
+- **GET** `/api/s` - Get stats about the instance
 
 # Self-host instructions
 
 ### Requirements
 
--   🦀 [Rust](https://www.rust-lang.org/) ≥ 1.58.0
--   🐈 [Yarn](https://yarnpkg.com/) ≥ 1.0.0
--   🐘 [PostgreSQL](https://www.postgresql.org/) ≥ 9.6
--   🦝 [Nginx](https://www.nginx.com/) ≥ 1.18.0
-    -  🌾 [Brotli plugin](https://github.com/google/ngx_brotli) recommended
--   🐧 [Linux](https://kernel.org/) or 😈 [FreeBSD](https://freebsd.org/)
--   🌄 Domain with [SSL](https://letsencrypt.org/)
+- 🦀 [Rust](https://www.rust-lang.org/) ≥ 1.58.0
+- 🐈 [Yarn](https://yarnpkg.com/) ≥ 1.0.0
+- 🐘 [PostgreSQL](https://www.postgresql.org/) ≥ 9.6
+- 🦝 [Nginx](https://www.nginx.com/) ≥ 1.18.0
+  - 🌾 [Brotli plugin](https://github.com/google/ngx_brotli) recommended
+- 🐧 [Linux](https://kernel.org/) or 😈 [FreeBSD](https://freebsd.org/)
+- 🌄 Domain with [SSL](https://letsencrypt.org/)
 
-### Steps
+<details>
+	<summary><h3>Steps</h3></summary>
 
 Please run each command one at a time!
 
@@ -88,9 +89,10 @@ cargo build --release
 ./target/release/zer0bin-bin # Preferably in a tmux session or as a service
 ```
 
-### Configuration
+</details>
 
 <details>
+	<summary><h3>Configuration</h3></summary>
 
 | Key                                        | Values                   | Description                                                                    |
 | ------------------------------------------ | ------------------------ | ------------------------------------------------------------------------------ |
@@ -112,16 +114,19 @@ cargo build --release
 ###### Measured with Lighthouse and Firefox Network Performance Analysis
 
 <details>
-
+	<summary><h3>Results</h3></summary>
+	
 ### Homepage
 
-![image](https://user-images.githubusercontent.com/44733677/158523056-2d1b4a38-76f8-413f-b4df-5fd3d920dc66.png)
-![image](https://user-images.githubusercontent.com/44733677/158523711-19f34696-b88f-4a6c-9a66-a77cf2f3e74e.png)
+![image](https://user-images.githubusercontent.com/44733677/159143364-a6e06aee-256e-4998-83f2-541c77e85184.png)
+![image](https://user-images.githubusercontent.com/44733677/159143316-c8e95ed6-ec32-44b3-abcc-18bd204a004d.png)
+![image](https://user-images.githubusercontent.com/44733677/159143321-aa8a5f6f-53d2-40d1-bff9-71d72347e7ea.png)
 
 ### 20 line paste
 
-![image](https://user-images.githubusercontent.com/44733677/158522958-a226612f-3848-43be-876e-8822a4cc9907.png)
-![image](https://user-images.githubusercontent.com/44733677/158523846-d79a94a5-64a5-475a-b481-e72141b47cf6.png)
+![image](https://user-images.githubusercontent.com/44733677/159143373-6e8787d8-61ef-44dc-9d66-52cd74e2a495.png)
+![image](https://user-images.githubusercontent.com/44733677/159143298-f8c7420d-ff76-4db7-a98e-03ff3615315e.png)
+![image](https://user-images.githubusercontent.com/44733677/159143303-efb71e15-623a-42cc-abf6-7e602843d801.png)
 
 </details>
 

README.md

@@ -1,12 +1,12 @@
 [package]
 name = "backend"
-version = "0.1.0"
+version = "0.7.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serde = "1.0"
+serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
 actix-rt = "2.6.0"
@@ -31,4 +31,4 @@ debug-assertions = false
 
 [[bin]]
 name = "zer0bin-bin"
-path = "src/main.rs"
+path = "src/main.rs"

backend/Cargo.lock

@@ -38,6 +38,7 @@ pub struct GetPasteResponse {
 #[derive(Serialize)]
 pub struct GetStatsResponse {
     pub count: i64,
+    pub version: String,
 }
 
 #[derive(Serialize)]

backend/Cargo.toml

@@ -19,6 +19,7 @@ use crate::{
 
 #[get("/s")]
 pub async fn get_stats(state: web::Data<AppState>) -> impl Responder {
+    let version = env!("CARGO_PKG_VERSION").to_string();
     // TODO: Maybe there's a less hacky way to do this..?
     let count: Result<i64, sqlx::Error> = sqlx::query(r#"SELECT COUNT(*) FROM pastes"#)
         .try_map(|row: PgRow| row.try_get::<i64, _>("count"))
@@ -41,6 +42,7 @@ pub async fn get_stats(state: web::Data<AppState>) -> impl Responder {
         success: true,
         data: GetStatsResponse {
             count: count.unwrap(),
+            version
         },
     })
 }

backend/src/models.rs

@@ -17,7 +17,7 @@ server {
 
     root /location/of/zer0bin/frontend/dist;
 
-    rewrite ^/~/(.*)$ /index.html;
+    rewrite ^/(?!.*api)(?!.*\.).*$ /index.html;
 
     location / {
         index index.html;

backend/src/routes.rs

@@ -0,0 +1 @@
+nodeLinker: node-modules

example.nginx

@@ -37,4 +37,4 @@ ul.noselect#messages
 		.line-numbers.noselect
 		pre#code-view-pre
 			code#code-view
-		textarea#text-area(spellcheck='false' autofocus='' name='value' aria-label='Paste input area')
+		textarea#text-area(spellcheck='false' autofocus='' name='value' aria-label='Paste input area' disabled='')

frontend/.yarnrc.yml

@@ -1,7 +1,7 @@
 {
 	"name": "zer0bin",
 	"source": "index.pug",
-	"version": "0.6.1",
+	"version": "0.7.1",
 	"browserslist": "> 0.5%, last 2 versions, not dead",
 	"license": "MIT",
 	"scripts": {
@@ -26,6 +26,7 @@
 		"@ant-design/icons-svg": "^4.2.1",
 		"highlight.js": "^11.4.0",
 		"js-confetti": "^0.10.2",
-		"smooth-scrollbar": "^8.7.4"
+		"smooth-scrollbar": "^8.7.4",
+		"tippy.js": "^6.3.7"
 	}
 }