A modern, privacy-focused, multiplatform application for consulting the ancient wisdom of the I Ching. Built with Tauri.
- Consult the I Ching: Perform readings and receive interpretations based on the ancient texts.
- Offline first: Fully functional without requiring an internet connection.
- Privacy by design: No user accounts, no tracking, no data collection. Your consultations remain private.
- Multiplatform: Runs on Desktop (Windows, macOS, Linux), iOS, and Android from a single codebase.
- Modern UI: Clean, intuitive, and accessible user interface.
If you find this project useful or interesting, please consider giving it a star on GitHub. Your support helps us grow and reach more contributors!
We are currently in the testing phase. Help us improve the app by joining our beta programs:
- iOS: Join the TestFlight Beta
- Android: Get it on Google Play
- Core Framework: Tauri
- Languages: TypeScript and Rust
- Styling: Tailwind with shadcn/ui components
- Package Manager: npm
-
Node.js (LTS version recommended) & npm
Recommended: use nvm to install and manage Node versions.
/usr/bin/curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash
nvm install --lts nvm use --lts
Or install Node LTS via your OS package manager:
- macOS:
brew install node
- Debian/Ubuntu:
sudo apt update
sudo apt install nodejs npm
- Windows (with Chocolatey):
choco install nodejs-lts -y
Make sure you have at least Node 16.
- macOS:
-
Rust & Cargo
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env
rustup update
-
Tauri Prerequisites (Ensure you follow the setup for your specific Operating System, including mobile development requirements if applicable).
Tauri needs some native toolkits to build its WebView.
xcode-select --install
sudo apt install -y build-essential pkg-config libgtk-3-dev libwebkit2gtk-4.0-dev
sudo dnf install -y gcc-c++ make pkgconfig gtk3-devel webkit2gtk3-devel
- Visual Studio 2022 Build Tools
- Download & install the “Desktop development with C++” workload (include Windows 10+ SDK).
- Windows SDK (if not bundled)
- (Optional) Python 2 for some Node native modules:
choco install python2 -y
- Ensure your toolchain target is set:
rustup default stable-x86_64-pc-windows-msvc
- Visual Studio 2022 Build Tools
- Clone the repository:
git clone https://github.com/corpora-inc/yijing.git cd yijing
- Install frontend dependencies:
npm install
- Run in development mode (Desktop):
This will open the app in a development window with hot-reloading for the frontend.
npm run tauri dev
- Build the application (Desktop):
Find the installers/binaries in
npm run tauri build
src-tauri/target/release/bundle/
. - Mobile Development:
- Refer to the official Tauri Mobile documentation for detailed instructions on setting up emulators/simulators and running/building for iOS and Android.
- Common commands:
npm run tauri android dev
,npm run tauri ios dev
,npm run tauri android build
,npm run tauri ios build
.
- Updating Tauri: upgrade both the CLI and the core crates in lockstep: cargo install tauri-cli --force npm install @tauri-apps/cli@latest
- Troubleshooting:
- On macOS, if the build fails in
cocoa
, make sure Xcode tools are current. - On Windows, double-check that the MSVC toolchain is active (
rustup show
).
- On macOS, if the build fails in
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Please read our contributions guidelines CONTRIBUTING.md
for more details
If you encounter bugs, have suggestions, or need help, please file an issue on the GitHub repository:
We respect your privacy. The application is designed to work offline and does not collect or transmit any personal data.
- Email: team@encorpora.io
- GitHub: https://github.com/corpora-inc
- Website: https://encorpora.io