https://github.com/theiceshelf/trunk

Language learning application.
https://github.com/theiceshelf/trunk

clojurescript electron

Last synced: 5 days ago
JSON representation

Language learning application.

• Host: GitHub
• URL: https://github.com/theiceshelf/trunk
• Owner: teesloane
• Created: 2021-07-12T00:41:20.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-13T18:27:28.000Z (about 2 years ago)
• Last Synced: 2024-10-20T12:47:34.518Z (3 months ago)
• Topics: clojurescript, electron
• Language: Clojure
• Homepage: https://theiceshelf.itch.io/trunk
• Size: 31.5 MB
• Stars: 84
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-language-learning - trunk - Very pretty UI, works pretty well (although the author says it's unstable) and supports 8 languages. (Language Learning / Learning With Texts (LinQ-like))

README

        
Trunk is a tool for learning new languages. It is inspired by [Learning With Texts](https://learningwithtexts.com/).

![](./docs/screenshots/trunk_word.png)

View more screenshots [here](./docs/screenshots).

⚠️ Trunk is currently under development and is not recommended for personal use.

With that said, it currently works as so:

1. Download the [latest release](https://github.com/theiceshelf/trunk/releases) for your platform.

2. Find and create an article to practice reading. 

3. Read the article while marking the familiarity of words and adding translations.

### Development

Requirements:

- Node JS 14+ + Yarn.

- Java runtime (for clojurescript compilation)

**Emacs**

1. Clone repo.

1. run `yarn install`

1. Open a clojurescript file (such as main/core.cljs)

1. Run `m-x cider-jack-in-clojurescript`

1. Follow the prompts to run a `shadow` repl (and `node-repl`).

1. Open your build running on `http://localhost:9630/dashboard`

1. Navigate to "Builds"

1. Press `Watch` button for `main` and `renderer` builds.

1. Run `yarn dev-electron` in a new terminal.

**In Terminal**

1. Clone repo.

1. `yarn install`

1. In one terminal run `yarn dev-cljs`

1. Open your build running on `http://localhost:9630/dashboard`

1. Navigate to "Builds"

1. Press `Watch` button for `main` and `renderer` builds.

1. In another terminal, run `yarn dev-electron`

Note: from time to time you will likely need to restart the `yarn dev-electron`

process if you make stateful changes to certain variables that are only defined

once, at boot.

### Contributing

- Use [conventional commit system](https://www.conventionalcommits.org/en/v1.0.0/).