Skip to content

akivajgordon/tikkun.io

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

tikkun.io

The online tikkun you always wanted, but never had.

The mission is to make better Torah readers by providing the tools to maximize the reader's efficiency and preparedness. Your good, old-fashioned tikkunim are great, but in the end, they're static papers. With the dynamic nature of computer programs, we can make an even better tikkun.

The source text is pulled from the Sefaria API, with some minor overrides as issues are found (such as פתוחה/סתומה discrepancies).

Contributing

Dependencies: Node.js 10+

Fork, clone, npm install.

Start the development process by running npm run dev. This will watch for file changes as you edit and start a local server on port 8000 where you can play with and test your changes. Just visit http://localhost:8000 in your browser.

Run unit tests with npm test, and watch for changes to automatically run the tests with npm run test:watch.

Run the UI tests with npm run test:ui.

Pull requests are welcome!

For bug fixes, kindly submit a failing test case that now passes as a result of the fix. For new features, submit test cases as well, which will improve the likelihood that the pull request will be merged. If you cannot write the test cases for whatever reason, add that as a note in the pull request so that we can discuss alternatives.

License

MIT