Ankilan/readme.md

37 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2020-03-25 15:12:53 +00:00
# AnkiLan
App provide creating automatically fill fields with English words and their definitions, examples, translates and add it to Anki.
2020-04-22 19:02:17 +00:00
App required already installed [Anki](https://apps.ankiweb.net/) on your phone.
2020-03-25 15:12:53 +00:00
- - -
![screenshot](./readme-files/screenshot1.png)
2020-04-22 18:50:23 +00:00
## Install
You can download latest the release from [releases page](https://github.com/Horhik/ankilan/releases)
2020-03-25 15:12:53 +00:00
## Build and start
2020-03-25 15:14:33 +00:00
```bash
2020-03-25 15:12:53 +00:00
git clone https://github.com/Horhik/ankilan
yarn install
yarn start
# launch paralell
react-native run-android
```
if something not working read [react native docs](https://reactnative.dev/docs/getting-started)
## Debug
2020-03-25 15:13:47 +00:00
##### For linux:
2020-03-25 15:12:53 +00:00
Read [this](https://gist.github.com/Horhik/28c40259a79fabdd358822cede105c09#file-rn-redux-devtools-md)
Instead yarn start and react-native run-android, you may launch `./rn-start.sh` and `./tools-start.sh`
2020-03-25 15:13:47 +00:00
##### Other
2020-03-25 15:12:53 +00:00
It's up to you 😜
## Goals
- [x] ~~Basic functional~~
- [ ] Add Urban dictionary support
- [ ] Support for other languages than Russian
2020-04-22 18:50:23 +00:00
- [ ] Add fields editor (without bugs 🙃)
2020-03-25 15:12:53 +00:00
- [ ] Add dark theme
- [ ] Create flexibility models
2020-03-25 15:13:47 +00:00
- [ ] Download sound of word to filesystem