Local Development

​

​

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
├── api
├── dashboard
├── docs
├── engine
├── mobile
├── website
packages
├── documents
├── email
├── events
├── import
├── inbox
├── invoice
├── jobs
├── kv
├── location
├── notification
├── supabase
├── tsconfig
├── ui
├── utils

The 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 travel engine (travelese.ai/engine).
• mobile: Travelese’s mobile app.
• website: Travelese’s website app (travelese.ai).

The packages directory contains the code for:

• documents: OCR for reciepts.
• events: Analytics library.
• import: CSV-importer.
• inbox: Inbox utils.
• invoice: Invoice 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:

• A Supabase account
• An Upstash account

​

Step 1: Local setup

First, you’ll need to clone the Travelese repo and install the dependencies.

git clone https://github.com/travelese/travelese.git

bun i