# Lurnby
A tool for building a personal knowledge practice. Lurnby helps you read and remember more. It works with web articles and epubs, allowing you to highlight, categorize, and review your content with active recall and spaced reptition tools.

[![codecov](https://codecov.io/gh/roznoshchik/lurnby/branch/main/graph/badge.svg)](https://codecov.io/gh/roznoshchik/lurnby/branch/main)


## Backend
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge&logo=flask&logoColor=white)
![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)
![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white)
<img style="background-color:white" src="https://www.sqlalchemy.org/img/sqla_logo.png" height="28px">

## Frontend

![Preact](https://img.shields.io/badge/preact-%23673AB8.svg?style=for-the-badge&logo=preact&logoColor=white)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
<img style="background-color:white" src="https://jinja.palletsprojects.com/en/3.1.x/_images/jinja-logo.png" height="28px">

- [Reusable Components](./client/COMPONENTS.md)
- [Frontend Services](./client/SERVICES.md)

## Screenshots
![Mobile](./app/static/images/lurnbyMobileScreens.png)
![Desktop](./app/static/images/lurnbyDesktop.png)

## Getting Started
Instructions for getting the app up and running are documented in the [Install.md](./install.md) script.

## Contributing
Contributions are welcome. Features and issues are documented in the [github issues](https://github.com/Roznoshchik/Lurnby/issues) tab. Fork the repo and submit a pull request for review.