|
1 |
| - |
2 |
| - |
3 |
| - |
4 |
| -# Ziho |
5 |
| - |
6 |
| -Ziho is an online programme for flashcards. It helps the user memorise information by utilising cognitive science strategies like spaced repetition and active recall testing. |
7 |
| - |
8 |
| - |
9 |
| -## Built With |
| 1 | +<p align="center"> |
| 2 | + <img title="Ziho Logo" src="https://shanukun.github.io/static/images/ziho/ziho-logo.png" align="center"> |
| 3 | +</p> |
10 | 4 |
|
11 |
| -- [Flask](https://flask.palletsprojects.com/en/3.0.x/) |
12 |
| -- [SQLite](https://sqlite.org/) |
13 |
| -- [Docker](https://www.docker.com/) |
| 5 | +<p align="center"> |
| 6 | + <b>Create, Study and Share</b> decks of flashcards. |
| 7 | +</p> |
14 | 8 |
|
15 |
| -## Screenshots |
| 9 | +<p align="center"> |
16 | 10 |
|
17 |
| -<p float="left"> |
18 |
| -<img src="./screenshots/home.png" width="400"> |
19 |
| -<img src="./screenshots/create-deck.png" width="400"> |
20 |
| -<img src="./screenshots/view-deck.png" width="400"> |
21 |
| -<img src="./screenshots/study.png" width="400"> |
22 |
| -<img src="./screenshots/updatecard.png" width="400"> |
23 |
| -<img src="./screenshots/profile.png" width="400"> |
24 |
| -<img src="./screenshots/explore.png" width="400"> |
| 11 | + <a href="https://img.shields.io/github/actions/workflow/status/shanukun/Ziho/ziho.yml"> |
| 12 | + <img title="Build Status" src="https://img.shields.io/github/actions/workflow/status/shanukun/Ziho/ziho.yml" /> |
| 13 | + </a> |
| 14 | + <a href="https://readthedocs.org/projects/activitywatch/badge/?version=latest"> |
| 15 | + <img title="Github commit activity" src="https://img.shields.io/github/commit-activity/w/shanukun/Ziho/main" /> |
| 16 | + </a> |
25 | 17 | </p>
|
26 | 18 |
|
27 | 19 |
|
28 |
| -## Getting Started |
| 20 | +## About |
29 | 21 |
|
30 |
| -### Install & Run |
| 22 | +Ziho is a prototype for a better online interface for Anki than [Anki Web](https://ankiweb.net/decks). |
| 23 | +Ziho allows you to create, study and easily share and clone decks, as well as edit them online. |
31 | 24 |
|
32 |
| -- Setup |
33 |
| -``` |
34 |
| -./tools/setup |
35 |
| -``` |
| 25 | +The backend is built with **Flask**, and the [fsrs](https://github.com/open-spaced-repetition) algorithm is used for spaced repetition. |
36 | 26 |
|
37 |
| -- Run |
| 27 | +<span><img src="https://shanukun.github.io/static/images/ziho/home.png" width="30%"></span> |
| 28 | +<span><img src="https://shanukun.github.io/static/images/ziho/study-deck.png" width="25%"></span> |
38 | 29 |
|
39 |
| -``` |
40 |
| -./tools/run-ziho |
41 |
| -``` |
| 30 | +You can find more screenshots [here](https://shanukun.github.io/ziho-ss/). |
42 | 31 |
|
43 |
| -- For dev enviroment |
44 | 32 |
|
45 |
| -``` |
46 |
| -./tools/run-ziho-dev |
47 |
| -``` |
48 |
| - |
49 |
| -- For docker container |
50 |
| - |
51 |
| -``` |
52 |
| -docker compose up |
53 |
| -``` |
54 |
| - |
55 |
| -## Contribution |
| 33 | +## Getting Started |
56 | 34 |
|
57 |
| -**Be consistent with existing code** |
| 35 | +### Quick Start with Docker |
58 | 36 |
|
59 |
| -### Use the linters |
| 37 | +> [!IMPORTANT] |
| 38 | +> Please ensure you have Docker and Docker Compose installed on your system. |
60 | 39 |
|
| 40 | +1. **Clone the Repository.** |
| 41 | +2. **Start the Docker Container** |
| 42 | +```bash |
| 43 | +docker compose up -d |
61 | 44 | ```
|
62 |
| -./tools/lint_and_format |
63 |
| -``` |
64 |
| - |
65 |
| -### Use the tests |
66 | 45 |
|
67 |
| -``` |
68 |
| -pytest tests/ |
69 |
| -``` |
0 commit comments