https://github.com/lee88688/epub-reader-server
epub reader app server
https://github.com/lee88688/epub-reader-server
eggjs epub epub-reader reader
Last synced: 28 days ago
JSON representation
epub reader app server
- Host: GitHub
- URL: https://github.com/lee88688/epub-reader-server
- Owner: lee88688
- Created: 2020-08-05T09:56:17.000Z (about 5 years ago)
- Default Branch: dev
- Last Pushed: 2021-01-20T07:33:50.000Z (over 4 years ago)
- Last Synced: 2025-02-23T10:26:44.193Z (7 months ago)
- Topics: eggjs, epub, epub-reader, reader
- Language: JavaScript
- Homepage:
- Size: 278 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# epub-reader
this project is inspired by [Android APP Lithium](https://play.google.com/store/apps/details?id=com.faultexception.reader&hl=en_US&gl=US). Lithium is a very great reader app for offline epub book. this project with [reader app](https://github.com/lee88688/epub-reader-app) is a online reader service for epub book. all with books, marks and bookmarks is store on server.
current features:
- category
- marks with comments
- bookmarks
- display toc
- pc and mobile compatible
feel free to give a new issue and pull requests.
## build docker image
To build docker image, it need download [reader app](https://github.com/lee88688/epub-reader-app) release(epub-reader-app.zip) and extract to root/public directory and build.
when run docker image, you need give `MONGO_DB` env for mongodb uri, and mount folder to `/opt/asar` for users' uploading books.
## QuickStart
see [egg docs][egg] for more detail.
### Development
```bash
$ npm i
$ npm run dev
$ open http://localhost:7001/
```
### Deploy
```bash
$ npm start
$ npm stop
```
### npm scripts
- Use `npm run lint` to check code style.
- Use `npm test` to run unit test.
- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
[egg]: https://eggjs.org