📚 Shoten

An e-book platform for a great reading experience with a search interface to find books and audiobooks.

💭 Main ideas

🤩 Features

• 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)

🧐 Reading

• position
• dictionary
• annotations
• notes (with folders)

⌨️ Keyboard access

• shortcuts
• navigation

📚 Bookshelf

• favorites
• to read -> future
• reading now -> present
• have read -> past
• reviewed
• recently viewed
• recommendations

Built with:

• Svelte
• FastAPI

Installation

• Make sure to install Node.js, Yarn and Python

1. Clone the project

    git clone --depth=1 https://github.com/Lulzx/shoten.git
    cd shoten
   

2. 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
   

3. Install and run frontend (http://localhost:5000)

   yarn install
   yarn dev:nollup
   

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is available in Public Domain, you're free to use it without any restrictions.