Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evan-buss/openbooks
Search and Download eBooks
https://github.com/evan-buss/openbooks
ebooks go golang irc irchighway openbooks react self-hosted
Last synced: 28 days ago
JSON representation
Search and Download eBooks
- Host: GitHub
- URL: https://github.com/evan-buss/openbooks
- Owner: evan-buss
- License: mit
- Created: 2019-05-15T16:35:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T18:42:56.000Z (about 2 months ago)
- Last Synced: 2024-10-01T15:22:05.629Z (about 1 month ago)
- Topics: ebooks, go, golang, irc, irchighway, openbooks, react, self-hosted
- Language: Go
- Homepage: https://evan-buss.github.io/openbooks/
- Size: 43.9 MB
- Stars: 1,868
- Watchers: 14
- Forks: 59
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - openbooks
README
# openbooks
> NOTE: Going forward only the latest release will be supported. If you encounter any issues, be sure you are using the latest version.
[](https://hub.docker.com/r/evanbuss/openbooks/)
Openbooks allows you to download ebooks from irc.irchighway.net quickly and easily.
## Getting Started
### Binary
1. Download the latest release for your platform from the [releases page](https://github.com/evan-buss/openbooks/releases).
2. Run the binary
- Linux users may have to run `chmod +x [binary name]` to make it executable
3. `./openbooks --help`
- This will display all possible configuration values and introduce the two modes; CLI or Server.
### Docker
- Basic config
- `docker run -p 8080:80 evanbuss/openbooks`
- Config to persist all eBook files to disk
- `docker run -p 8080:80 -v /home/evan/Downloads/openbooks:/books evanbuss/openbooks --persist`
### Setting the Base Path
OpenBooks server doesn't have to be hosted at the root of your webserver. The basepath value allows you to host it behind a reverse proxy. The base path value must have opening and closing forward slashes (default "/").
- Docker
- `docker run -p 8080:80 -e BASE_PATH=/openbooks/ evanbuss/openbooks`
- Binary
- `./openbooks server --basepath /openbooks/`
## Usage
For a complete list of features use the `--help` flags on all subcommands.
For example `openbooks cli --help or openbooks cli download --help`. There are
two modes; Server or CLI. In CLI mode you interact and download books through
a terminal interface. In server mode the application runs as a web application
that you can visit in your browser.
Double clicking the executable will open the UI in your browser. In the future it may use [webviews](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) to provide a "native-like" desktop application.
## Development
### Install the dependencies
- `go get`
- `cd server/app && npm install`
- `cd ../..`
- `go run main.go`
### Build the React SPA and compile binaries for multiple platforms.
- Run `./build.sh`
- This will install npm packages, build the React app, and compile the executable.
### Build the go binary (if you haven't changed the frontend)
- `go build`
### Mock Development Server
- The mock server allows you to debug responses and requests to simplified IRC / DCC
servers that mimic the responses received from IRC Highway.
- ```bash
cd cmd/mock_server
go run .
# Another Terminal
cd cmd/openbooks
go run . server --server localhost --log
```
### Desktop App
Compile OpenBooks with experimental webview support:
``` shell
cd cmd/openbooks
go build -tags webview
```
## Why / How
- I wrote this as an easier way to search and download books from irchighway.net. It handles all the extraction and data processing for you. You just have to click the book you want. Hopefully you find it much easier than the IRC interface.
- It was also interesting to learn how the [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) and [DCC](https://en.wikipedia.org/wiki/Direct_Client-to-Client) protocols work and write custom implementations.
## Technology
- Backend
- Golang
- Chi
- gorilla/websocket
- Archiver (extract files from various archive formats)
- Frontend
- React.js
- TypeScript
- Redux / Redux Toolkit
- Mantine UI / @emotion/react
- Framer Motion