- TypeScript 98.1%
- HTML 1.2%
- JavaScript 0.4%
- CSS 0.2%
|
|
||
|---|---|---|
| .github/workflows | ||
| .husky | ||
| apps | ||
| assets | ||
| nginx | ||
| packages | ||
| scripts | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| .npmrc | ||
| biome.json | ||
| CONTRIBUTING.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| LICENSE | ||
| LICENSE.enterprise | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| postcss.config.cjs | ||
| README.md | ||
| tsconfig.json | ||
| turbo.json | ||
Usertour is an open-source user onboarding platform. It allows you to create in-app product tours, checklists, and surveys in minutes—effortlessly and with full control.
Website | Documentation | Blog | Twitter | Discord
Quick Start
Self-deploy with Docker
Deploy your own feature-rich, unlimited version of Usertour using Docker.
To start deployment:
cp .env.example .env # make sure all required envs are properly set
docker compose up -d
Visit http://localhost:8011 to start using Usertour.
View details in Self-hosting.
One Click Deployment
Local Development
View details in CONTRIBUTING.
Features
Usertour makes it easy to design in-app product tours, checklists, launchers, and surveys, enabling anyone to craft effective onboarding experiences. Our team is dedicated to consistently improving Usertour with frequent updates that include new features, bug fixes, and performance enhancements.
Easy Onboarding: Build Flows Fast with Simple Integration and Smart Targeting
- 🌐 Compatible with all frameworks: If your app runs in a browser, it seamlessly integrates with Usertour.
- 📄 Supports multi-page apps: Whether it's a single-page application or spans across multiple pages, Usertour fits perfectly.
- 🎯 Advanced user targeting: Define custom user attributes and track events to segment and engage your audience effectively.
Built for professional workflows with version control and environments
- 🛠️ Multiple environments supported: Manage environments like Production and Staging within a single Usertour account.
- 🔄 Version tracking: Monitor every change in your flows, including who made adjustments and when.
Fully customizable appearance
- 🎨 Tailor your design: Adjust text, button colors, font family, and size to match your branding.
- 🖌️ Support for multiple themes: Create unique themes for different flows, offering flexibility for varied use cases.
Gain actionable insights with powerful analytics
- 📊 Performance metrics: Track the effectiveness of your flows with detailed data on views and completion rates.
- 🚨 Identify problem areas: Pinpoint steps causing user confusion or drop-offs and address the issues seamlessly.
How to Use?
- Cloud
- We've deployed a Usertour Cloud version that allows zero-configuration usage, offering all capabilities of the self-hosted version. Visit https://www.usertour.io/ to get started.
- Self-hosting Usertour Community Edition
- Get started quickly with our Self-hosting Guide to run Usertour in your environment. For more detailed references and in-depth instructions, please refer to our documentation.
- Usertour for enterprise / organizations
- Please contact us at support@usertour.io for private deployment solutions.
Contributing Guidelines
| Bug Reports | Feature Requests | Issues/Discussions | Usertour Community |
|---|---|---|---|
| Create Bug Report | Submit Feature Request | View GitHub Discussions | Visit Usertour Community |
| Something isn't working as expected | Ideas for new features or improvements | Discuss and raise questions | A place to ask questions, learn, and connect with others |
Calling all developers, testers, tech writers and more! Contributions of all types are more than welcome, please feel free to browse our GitHub issues to show us what you can do.
For bug reports, feature requests, and other suggestions, you can also create a new issue and choose the most appropriate template to provide feedback.
If you have any questions, feel free to reach out to us. One of the best places to get more information and learn is the Usertour Community, where you can connect with other like-minded individuals.
Community and Contact
- GitHub Discussion: Best for sharing feedback and asking questions.
- GitHub Issues: Best for reporting bugs and suggesting features when using Usertour. Please refer to our contribution guidelines.
- Discord: Best for sharing your applications and interacting with the community.
- X(Twitter): Best for sharing your applications and staying connected with the community.
Security Issues
To protect your privacy, please avoid posting security-related issues on GitHub. Instead, send your questions to support@usertour.io, and we will provide you with a more detailed response.
Credits
Some icons are provided by Remix Icon (https://remixicon.com), licensed under the Apache License.
License
Community code is licensed under the MIT license. See LICENSE.
Enterprise-licensed code for self-hosted Business and Enterprise plans is governed by LICENSE.enterprise.