Introduction
Travelese’s codebase is set up in a monorepo via Turborepo and is fully open-source on GitHub. Here’s the monorepo structure:apps directory contains the code for:
api: The backend for Travelese (supabase).dashboard: Travelese’s application (app.travelese.ai).docs: Travelese’s documentation site (travelese.ai/docs).engine: Travelese’s bank engine (travelese.ai/engine).mobile: Travelese’s mobile app.website: Travelese’s website app (travelese.ai).
packages directory contains the code for:
documents: OCR for receipts.events: Analytics library.import: CSV-importer.inbox: Inbox utils.jobs: Background jobs.kv: Key value storage client.location: Location related utils.notification: Notifications client.supabase: Queries and client.tsconfig: The TypeScript configuration for Travelese’s web app.ui: UI component library.utils: A collection of utility functions and constants used across Travelese’s codebase.
Running Travelese locally
To run Travelese locally, you’ll need to set up the following:Step 1: Local setup
First, you’ll need to clone the Travelese repo and install the dependencies.1
Clone the repo
First, clone the travelese.ai repo into a public GitHub repository.
Terminal
2
Install dependencies
Run the following command to install the dependencies:
Terminal