An e-book platform for a great reading experience with a search interface to find books and audiobooks.
- reading session
- search content
- activity data
- community forum
- user statistics
- personal bookshelf
- audiobooks [https://librivox.org]
- convert web articles to ebooks (in pdf, epub formats)
- position
- dictionary
- annotations
- notes (with folders)
- shortcuts
- navigation
- favorites
- to read -> future
- reading now -> present
- have read -> past
- reviewed
- recently viewed
- recommendations
-
Clone the project
git clone --depth=1 https://github.com/Lulzx/shoten.git cd shoten -
Install and run backend (http://localhost:8000)
git clone --depth=1 https://github.com/Lulzx/shoten-backend.git cd shoten-backend pip install -r requirements.txt python -m uvicorn server:app --reload -
Install and run frontend (http://localhost:5000)
yarn install yarn dev:nollup
| Syntax | Description |
|---|---|
dev |
Development (port 5000) |
dev:nollup |
Development with crazy fast rebuilds (port 5000) |
build |
Build a bundled app with SSR + pre-rendering and dynamic imports |
serve |
Run after a build to preview. Serves SPA on 5000 and SSR on 5005 |
export |
Create static pages from content in dist folder (used by yarn build) |
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is available in Public Domain, you're free to use it without any restrictions.