Local Development - Usertour documention

Getting Started

This guide will help you set up Usertour for local development. Follow these steps to get your development environment running:

1. Fork and Clone

Fork the Usertour repository
Clone your fork to your local machine:

git clone git@github.com:<your-github-username>/usertour.git
cd usertour

2. System Requirements

Before proceeding, ensure you have the following installed:

Redis - For caching and session management
PostgreSQL - For data storage
pnpm - For package management

3. Project Structure

Usertour is a monorepo containing multiple packages:

apps/
├── server/        # Backend API server
├── web/           # Frontend web application
├── sdk/           # Usertour.js SDK
│
packages/          # Shared packages
├── components/    # Reusable UI components
├── radix/         # Radix UI components
└── shared/        # Shared utilities and types

4. Setup Steps

Install Dependencies

pnpm install

Configure Environment

Set up environment variables for each component:

# Web application
cp apps/web/.env.example apps/web/.env

# API server
cp apps/server/.env.example apps/server/.env
# Update Redis and PostgreSQL configuration in apps/server/.env

# SDK
cp apps/sdk/.env.example apps/sdk/.env

Start Development Servers

You can run each component separately:

# Start the backend API server
pnpm dev:server

# Start the web application
pnpm dev:web

# Start the SDK development server
pnpm dev:sdk

Once running, you can access the web application at http://localhost:5174.

Contributing

Development Workflow

Create a new branch for your feature or bug fix
Make your changes following our style guidelines
Add tests for new features
Update documentation as needed
Submit a pull request

Branch Strategy

main - Production-ready code
develop - Integration branch for new features
Feature branches - Created from develop for new features

Getting Help

If you need assistance:

Join our Discord community
Check our Documentation
Ask in GitHub Discussions
Follow us on Twitter

Recognition

Contributors are featured in our README. We appreciate your help in making Usertour better!

​Getting Started

​1. Fork and Clone

​2. System Requirements

​3. Project Structure

​4. Setup Steps

​Contributing

​Development Workflow

​Branch Strategy

​Getting Help

​Recognition