steveruizok/mathberet

Mathberet is a self-hosted digital mathematics notebook written in React and Typescript, designed for math students who need a platform for graphing, sketching, and writing in LaTeX.

📝 Mathberet (Hebrew: מַתְבֶּרֶת) - A self-hosted digital mathematics notebook, written in React and built with Electron

🚧 In active development, open for contributions! 🚧

---

Currently works in Hebrew, English, Arabic, Russian and Spanish, localized using i18next. Still buggy.

✅ Features

• Block based drag-n-drop editor
• Text, Math, Graph and Drawing blocks are currently available
• LaTeX shortcuts and snippets
• Local files can be saved and loaded from the file system
• File tags (currently useless)
• Command bar (currently only used for user preferences)
• 6 color themes and light/dark theme
• Customize LaTeX shortcuts
• Shortcuts help menu
• Searching from command bar
• Adding points and polygons to graph blocks
• Math memory sidebar (for variable assignments and quick functions)
• Archive

📸 Screenshots

Hebrew

English

Dark theme and purple accent color

Light theme and green accent color

Command bar (Ctrl+Shift+P)

🧱 Built With

• ERWT: Electron + React apps boilerplate
• react-grid-layout: Grid layout for the blocks
• slate: Text block component
• MathLive (react-math-view): Math block component
• Mafs: Graph block component
• tldraw: Drawing block component
• kbar: Command bar
• react-complex-tree: Used for displaying the file system
• UIcons: App icons

🏗️ Building from source

1. Clone the repository to a folder on your machine:

git clone https://github.com/yonatanmgr/mathberet.git

2. Run npm install in the project root folder
3. Run npm start in the project root folder

🤝 Contributing

We welcome any positive contribution towards our project's growth! Whether you choose to work on a listed feature or create a new one, your help is appreciated. Simply submit a Pull Request after adding your code. To ensure a smooth process, please review our CODE OF CONDUCT and read the CONTRIBUTING guidelines for further details on submitting pull requests.

Make sure to visit Mathberet's project to view our roadmap and plans, and our wiki to read the documentation!

⚖️ Liscense

This project is licensed under the MIT License - see the LICENSE file for details.

🧑‍💻 Contributors

Yonatan Magier 🤔 💻 🚧 🌍 🎨

Erez Birenholz 🧑‍🏫 💻 🚧 🌍

Nadav Magier 💻 🚧 🌍 🛡️

Ziv Nadel 💻 🚧