rtl-epub-maker/README.md

# RTL EPUB Maker

Easily create EPUB e-book files with proper RTL support.

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.

### [Try it live - RTL EPUB Maker 📚](https://rtl-epub-maker.lingdocs.com)

## Running

You can run this app on your own machine or host it on a server.

### With Node

requires:

- Node.js 12.22.0 or later
- [pandoc](https://pandoc.org/installing.html)

To run in dev mode:

```sh
npm install
npm run dev
```

To host in production:

```sh
npm run build
npm run start
```

### With Docker

If you are using `linux/amd64` architecture you can just run the [the docker image](https://hub.docker.com/r/lingdocs/rtl-epub-maker).

```sh
docker compose up
```

If you are using an architecture other than `linux/amd64` you will need to build your own docker image.

```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.
initial commit 2022-02-09 22:23:08 +00:00			`# RTL EPUB Maker`

update README 2022-02-10 06:13:32 +00:00			`Easily create EPUB e-book files with proper RTL support.`
initial commit 2022-02-09 22:23:08 +00:00
cleanup 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.`
update README 2022-02-10 06:13:32 +00:00
language selector, but not quite workinhg yet 2022-02-10 07:27:34 +00:00			`### [Try it live - RTL EPUB Maker 📚](https://rtl-epub-maker.lingdocs.com)`
update README 2022-02-10 06:13:32 +00:00
			`## Running`

			`You can run this app on your own machine or host it on a server.`
initial commit 2022-02-09 22:23:08 +00:00
button label fix 2022-02-09 23:15:20 +00:00			`### With Node`

			`requires:`
touchup 2022-02-09 23:11:35 +00:00
			`- Node.js 12.22.0 or later`
			`- [pandoc](https://pandoc.org/installing.html)`
initial commit 2022-02-09 22:23:08 +00:00
update README 2022-02-10 06:13:32 +00:00			`To run in dev mode:`

			```sh
initial commit 2022-02-09 22:23:08 +00:00			`npm install`
			`npm run dev`
			```

update README 2022-02-10 06:13:32 +00:00			`To host in production:`

			```sh
			`npm run build`
			`npm run start`
			```

initial commit 2022-02-09 22:23:08 +00:00			`### With Docker`

update README 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).
initial commit 2022-02-09 22:23:08 +00:00
update README 2022-02-10 06:13:32 +00:00			```sh
initial commit 2022-02-09 22:23:08 +00:00			`docker compose up`
			```

language selector, but not quite workinhg yet 2022-02-10 07:27:34 +00:00			If you are using an architecture other than `linux/amd64` you will need to build your own docker image.
update README 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.

			`---`

language selector, but not quite workinhg yet 2022-02-10 07:27:34 +00:00			`Code is licensed under an [MIT License](https://github.com/lingdocs/rtl-epub-maker/blob/master/LICENSE). Contributions are welcome.`