Forgotten files for previous commit.
	
		
			
	
		
	
	
		
	
		
			Some checks failed
		
		
	
	
		
			
				
	
				continuous-integration/drone/push Build is failing
				
			
		
		
	
	
				
					
				
			
		
			Some checks failed
		
		
	
	continuous-integration/drone/push Build is failing
				
			This commit is contained in:
		
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,9 +1,11 @@ | ||||
| # Fast Pastebin | ||||
|  | ||||
| [](https://github-ci.pztrn.name/pztrn/fastpastebin)  | ||||
| [](https://ci.code.pztrn.name/apps/fastpastebin) | ||||
|  | ||||
| Easy-to-use-and-install pastebin software written in Go. No bells or whistles, no websockets and even NO JAVASCRIPT! | ||||
|  | ||||
| **Please, use [my gitea](https://code.pztrn.name/apps/fastpastebin) for bug reporting. All other places are mirrors!** | ||||
|  | ||||
| ## Current functionality | ||||
|  | ||||
| * Create and view public and private pastes. | ||||
| @@ -21,7 +23,7 @@ Easy-to-use-and-install pastebin software written in Go. No bells or whistles, n | ||||
| Just issue: | ||||
|  | ||||
| ```bash | ||||
| CGO_ENABLED=0 go get -u -v go.dev.pztrn.name/fastpastebin/cmd/fastpastebin | ||||
| CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@latest | ||||
| ``` | ||||
|  | ||||
| This command can be used to update Fast Paste Bin. | ||||
| @@ -34,18 +36,13 @@ Configuration file position is irrelevant, there is no hardcoded paths where Fas | ||||
|  | ||||
| ## Developing | ||||
|  | ||||
| Developers should install [fileb0x](https://github.com/UnnoTed/fileb0x/) which is used as replacement to go-bindata for embedding assets into binary. After changing assets they should be recompiled into Go code. At repository root execute this command and you'll be fine: | ||||
| Use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting | ||||
| actions automagically. | ||||
|  | ||||
| ```bash | ||||
| fileb0x fileb0x.yml | ||||
| ``` | ||||
| Also, Sublime Text with LSP-gopls will also work just fine. | ||||
|  | ||||
| Also if you're changed list of assets (by creating or deleting them) be sure to fix files list in ``fileb0x.yml`` file! | ||||
| Try to follow [Go's code review comments](https://github.com/golang/go/wiki/CodeReviewComments) with few exceptions: | ||||
|  | ||||
| The rest is default - use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting | ||||
| actions automagically. Try to follow [Go's code review comments](https://github.com/golang/go/wiki/CodeReviewComments) with few exceptions: | ||||
|  | ||||
| * Imports should be organized in 3 groups: stdlib, local, other. See [this file](https://sources.dev.pztrn.name/fastpastebin/fastpastebin/src/branch/master/domains/pastes/paste_get.go) for example. | ||||
| * We're not forcing any limits on line length for code, only for comments, they should be 72-76 chars long. | ||||
|  | ||||
| ## ToDo | ||||
|   | ||||
							
								
								
									
										112
									
								
								fileb0x.yml
									
									
									
									
									
								
							
							
						
						
									
										112
									
								
								fileb0x.yml
									
									
									
									
									
								
							| @@ -1,112 +0,0 @@ | ||||
| # all folders and files are relative to the path  | ||||
| # where fileb0x was run at! | ||||
|  | ||||
| # default: main | ||||
| pkg: static | ||||
|  | ||||
| # destination | ||||
| dest: "./assets/static/" | ||||
|  | ||||
| # gofmt | ||||
| # type: bool | ||||
| # default: false | ||||
| fmt: false | ||||
|  | ||||
| # compress files | ||||
| # at the moment, only supports gzip | ||||
| # | ||||
| # type: object | ||||
| compression: | ||||
|   # activates the compression | ||||
|   # | ||||
|   # type: bool | ||||
|   # default: false | ||||
|   compress: false | ||||
|  | ||||
|   # valid values are: | ||||
|   # -> "NoCompression" | ||||
|   # -> "BestSpeed" | ||||
|   # -> "BestCompression" | ||||
|   # -> "DefaultCompression" or "" | ||||
|   # | ||||
|   # type: string | ||||
|   # default: "DefaultCompression" # when: Compress == true && Method == "" | ||||
|   method: "" | ||||
|  | ||||
|   # true = do it yourself (the file is written as gzip compressed file into the memory file system) | ||||
|   # false = decompress files at run time (while writing file into memory file system) | ||||
|   # | ||||
|   # type: bool | ||||
|   # default: false | ||||
|   keep: false | ||||
|  | ||||
| # --------------- | ||||
| # -- DANGEROUS -- | ||||
| # --------------- | ||||
| #  | ||||
| # cleans the destination folder (only b0xfiles) | ||||
| # you should use this when using the spread function | ||||
| # type: bool | ||||
| # default: false | ||||
| clean: true | ||||
|  | ||||
| # default: ab0x.go | ||||
| output: "ab0x.go" | ||||
|  | ||||
| # [unexporTed] builds non-exporTed functions, variables and types... | ||||
| # type: bool | ||||
| # default: false | ||||
| unexporTed: false | ||||
|  | ||||
| # [spread] means it will make a file to hold all fileb0x data | ||||
| # and each file into a separaTed .go file | ||||
| # | ||||
| # example: | ||||
| # theres 2 files in the folder assets, they're: hello.json and world.txt | ||||
| # when spread is activaTed, fileb0x will make a file:  | ||||
| # b0x.go or [output]'s data, assets_hello.json.go and assets_world.txt.go | ||||
| # | ||||
| # | ||||
| # type: bool | ||||
| # default: false | ||||
| spread: true | ||||
|  | ||||
| # [lcf] log changed files when spread is active | ||||
| lcf: true | ||||
|  | ||||
| # type: array of objects | ||||
| custom: | ||||
|  | ||||
|   # type: array of strings | ||||
|   - files:  | ||||
|     - "assets/css/bulma-0.7.5.min.css" | ||||
|     - "assets/css/bulma-tooltip-3.0.0.min.css" | ||||
|     - "assets/css/bulma.css.map" | ||||
|     - "assets/css/style.css" | ||||
|     - "assets/js/fontawesome-5.0.7.js" | ||||
|  | ||||
|     # base is the path that will be removed from all files' path | ||||
|     # type: string | ||||
|     base: "assets" | ||||
|  | ||||
|     # prefix is the path that will be added to all files' path | ||||
|     # type: string | ||||
|     prefix: "static/" | ||||
|   # end: files | ||||
|   - files: | ||||
|     - "assets/database_not_available.html" | ||||
|     - "assets/error.html" | ||||
|     - "assets/footer.html" | ||||
|     - "assets/index.html" | ||||
|     - "assets/main.html" | ||||
|     - "assets/navigation.html" | ||||
|     - "assets/pagination_ellipsis.html" | ||||
|     - "assets/pagination_link_current.html" | ||||
|     - "assets/pagination_link.html" | ||||
|     - "assets/pagination.html" | ||||
|     - "assets/passworded_paste_verify.html" | ||||
|     - "assets/paste.html" | ||||
|     - "assets/pastelist_list.html" | ||||
|     - "assets/pastelist_paste.html" | ||||
|     base: "assets" | ||||
|     prefix: "" | ||||
		Reference in New Issue
	
	Block a user