Thank you for your interest in contributing to Oculus! We welcome contributions from the community.
- Rust: Install from rustup.rs.
- Node.js / Bun: This project uses Bun as the package manager.
- Tauri CLI: The project uses the local Tauri CLI via
bun tauri.
-
Clone the repository:
git clone https://github.com/GridlineDigital/oculus.git cd oculus -
Install dependencies:
bun install
-
Run the development server:
bun tauri dev
This command will start the frontend dev server and the Tauri application window.
src/: SvelteKit frontend code.src-tauri/: Rust backend code.docs/: Project documentation.
- Type Checking: Run
bun checkto verify TypeScript types. - Styling: Use the semantic theme classes defined in
src/app.css(e.g.,bg-glass,text-text-secondary) instead of hardcoded colors. - Backend: We use
rustfmt. Runcargo fmtin thesrc-tauridirectory.
- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes and commit them.
- Push to your fork and submit a Pull Request.