rtl-epub-maker/README.md

56 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-02-09 22:23:08 +00:00
# RTL EPUB Maker
2022-02-10 06:13:32 +00:00
Easily create EPUB e-book files with proper RTL support.
2022-02-09 22:23:08 +00:00
2022-02-10 12:05:20 +00:00
This is a web app that uses [pandoc](https://pandoc.org) to create .epub files for e-books in RTL languages. Making e-books for right-to-left languages can be tricky. This tries app tries to simplify the process as much as possible, so that anyone can make them.
2022-02-10 06:13:32 +00:00
### [Try it live - RTL EPUB Maker 📚](https://rtl-epub-maker.lingdocs.com)
2022-02-10 06:13:32 +00:00
## Running
You can run this app on your own machine or host it on a server.
2022-02-09 22:23:08 +00:00
2022-02-09 23:15:20 +00:00
### With Node
requires:
2022-02-09 23:11:35 +00:00
- Node.js 12.22.0 or later
- [pandoc](https://pandoc.org/installing.html)
2022-02-09 22:23:08 +00:00
2022-02-10 06:13:32 +00:00
To run in dev mode:
```sh
2022-02-09 22:23:08 +00:00
npm install
npm run dev
```
2022-02-10 06:13:32 +00:00
To host in production:
```sh
npm run build
npm run start
```
2022-02-09 22:23:08 +00:00
### With Docker
2022-02-10 06:13:32 +00:00
If you are using `linux/amd64` architecture you can just run the [the docker image](https://hub.docker.com/r/lingdocs/rtl-epub-maker).
2022-02-09 22:23:08 +00:00
2022-02-10 06:13:32 +00:00
```sh
2022-02-09 22:23:08 +00:00
docker compose up
```
If you are using an architecture other than `linux/amd64` you will need to build your own docker image.
2022-02-10 06:13:32 +00:00
```sh
docker build . -t rtl-epub-maker
docker run -p 127.0.0.1:3001:3001 rtl-epub-maker
```
## Serving
The app will be served on `http://localhost:3001`. Add a reverse proxy with SSL if you want to serve it to the world.
---
Code is licensed under an [MIT License](https://github.com/lingdocs/rtl-epub-maker/blob/master/LICENSE). Contributions are welcome.