Skip to content

Commit

Permalink
Merge pull request #4 from serenevoid/development
Browse files Browse the repository at this point in the history
Development
  • Loading branch information
serenevoid authored Oct 8, 2022
2 parents 6a5f050 + 49ab19d commit 5f2de81
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 6 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
# Boarder
##### A minimal 4chan board hoarder

## Features
- simple text file to add new threads
- download all media + thumbnails and their post informations
- media and thumbnails on separate folders to enable browsing media alone
- creates json file of the data on the individual folders
- creates a static html file for each thread to view the thread as a whole
- Features of Static html
- Better UI
- Responsive
- Clicking on media goes to preview mode (similar to discord web client)
- Clicking on url opens media on new tab

## WIP
This is not fully baked, but still usable. If you experience any issues,
see some improvement you think would be amazing, or just have some feedback
for boarder, make an issue!

## Usage
Add `threads.txt` on the folder where you will be running boarder. The
contents of the file would be the list of threads you want to subscribe to.
The format to add a thread is `board_thread`.
Add `threads.txt` and `template.html` on the folder where you will be running boarder.
The contents of the text file would be the list of threads you want to subscribe to.
The format to add a thread is `(board ID)_(thread No.)`.
```
// Anime Wallpaper
w_2185924
Expand All @@ -19,3 +31,11 @@ w_2223911
wg_7934675
wg_7920373
```

## Screenshots
- Terminal View
![Terminal](./screenshots/terminal.png "Terminal")
- Normal View
![Normal Mode](./screenshots/normal_mode.png "Normal Mode")
- Preview Mode
![Preview Mode](./screenshots/preview_mode.png "Preview Mode")
2 changes: 0 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ func main() {

var file_list []models.File

fmt.Println("BOARDER V0.1.0")

entry_list, err := util.Load_config()
if err != nil {
fmt.Print("Error: ", err)
Expand Down
Binary file added screenshots/normal_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/preview_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion storage/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func Store_posts_as_json(entry string, posts []models.Post) error {
}

func Create_html_page(entry string, posts []models.Post) error {
t := template.Must(template.ParseFiles("./storage/template.html"))
t := template.Must(template.ParseFiles("./template.html"))
entry_elements := strings.Split(entry, "_")
board := entry_elements[0]
thread := entry_elements[1]
Expand Down
File renamed without changes.

0 comments on commit 5f2de81

Please sign in to comment.