DEV Community: Aditya Deshlahre

Streamlining Research and Analysis with OpenBB

Aditya Deshlahre — Wed, 30 Oct 2024 22:27:30 +0000

Introduction

For investors aiming to make informed decisions, a simple glance at price trends isn’t enough—they require a thorough examination of a company's fundamentals. OpenBB Terminal, an open-source investment research platform, equips users with a robust toolkit for conducting in-depth fundamental analysis. In this post, we'll explore the key features of OpenBB for fundamental analysis and provide practical examples to help you get started.

What is OpenBB Terminal?

OpenBB Terminal is a free, open-source command-line interface (CLI) platform tailored for comprehensive research in stocks, cryptocurrencies, options, ETFs, and more. With its extensive feature set, retail investors can perform analyses comparable to those conducted by institutional analysts—without the burden of costly subscription fees.

General System Requirements

To install OpenBB, you'll need:

Python Compatibility: OpenBB is compatible with Python versions 3.9 to 3.12.
Hardware: A modern processor (within the last five years) and at least 4GB of RAM.
Operating System: Up-to-date systems are recommended, with the following OS minimums:
- Windows: Windows 10 or newer
- macOS: Big Sur or newer
- Linux: For Linux users, it’s best to update your package manager before installation.

Supported Environments

OpenBB is installed in a Python virtual environment to avoid conflicts and ensure stability. Python environments can be created via Conda, venv, or an integrated development environment (IDE) like VS Code or PyCharm. For Docker users, there’s an installation method specific to Docker containers, which we cover below.

Tip: If you’re new to Python, we recommend reading up on virtual environments to understand how they help manage dependencies. Check out our guide on setting up environments in VS Code for additional help.

Installation Steps

Update the Package Manager Ensure you’re working with the latest version of pip by running:

pip install --upgrade pip

Create a Virtual Environment To keep OpenBB isolated from other Python projects, create a dedicated virtual environment. Here’s how with Conda:

conda create -n openbb python=3.11
conda activate openbb

Note: Installing packages directly into the system Python or base environment is not recommended.

Install OpenBB Install via your preferred method below:

PyPI: You can install OpenBB directly from the Python Package Index.
Docker: Docker setup offers isolation and ease of use. (See Docker-specific instructions below.)
Source: For developers or advanced users, installing from the source allows more customization.

Lets get started on how to install Open BB

Now OpenBB Platform can be installed as PyPI package using this command

pip install openbb

Installing All Extensions and Providers

For a comprehensive installation that includes all available extensions and data providers, run:

pip install openbb[all]

Tip for macOS Users: If you’re using the zsh shell, add quotation marks around the library name:

pip install "openbb[all]"

Installing Specific Extensions and Providers

OpenBB is modular, which means you can pick and choose the features you need. Here’s how to install specific extensions or providers based on your analysis needs.

Single Extension Installation:

For charting tools:

pip install openbb[charting]

For technical analysis tools:

pip install openbb[ta]

Single Provider Installation:

For the Yahoo Finance API integration:

pip install openbb[yfinance]

Nightly Distribution: The Cutting Edge

If you want to test the latest features, install the Nightly build. This includes all extras by default:

pip install openbb-nightly

This version may include new and experimental features but could also have minor instabilities, so it’s best suited for users who don’t mind testing cutting-edge updates.

Importing OpenBB

To start using OpenBB after installation, import it into your Python environment:

from openbb import obb

Note: Because of OpenBB’s structure, this single import line is necessary to access the platform. Imports such as from openbb.obb.equity import * are currently unsupported, so always use from openbb import obb for a stable experience.

When you load OpenBB, any installed extensions will automatically be detected and made available, so you can start using all features right away.

Installing the Core Package Only

If you want to install OpenBB without any extensions or providers, opt for the minimal openbb-core package:

pip install openbb-core && pip install openbb --no-deps

This installs the core platform only, giving you the flexibility to add specific tools as needed later on.

Keeping OpenBB Updated

To make sure you’re working with the latest features, update the OpenBB package regularly. Here’s how:

Core Package Update:

pip install --upgrade openbb

Update All Extensions and Providers:

pip install --upgrade openbb[all]

Installing OpenBB with Docker

Using Docker, you can set up the OpenBB Platform directly from the GitHub Container Registry or by building the Docker image from the source. Here’s how.

Pulling OpenBB from GitHub Container Registry
To get started quickly, use the prebuilt Docker image from GitHub’s Container Registry. Run the following command in your terminal:

docker run --rm -p 8000:8000 -v ~/.openbb_platform:/root/.openbb_platform ghcr.io/openbb-finance/openbb-platform:latest

Options explained:
--rm: Automatically removes the container when it stops.
-p 8000:8000: Exposes the API on port 8000.
-v ~/.openbb_platform:/root/.openbb_platform: Mounts the local ~/.openbb_platform directory into the container to store your API keys and preferences.

Building OpenBB from Source

For a more customizable setup, you can build the OpenBB Docker image from the source using the platform.dockerfile provided in the GitHub repository.

Clone the OpenBB Repository: If you haven’t already, clone the OpenBB GitHub repository to access the Dockerfile.

git clone https://github.com/openbb-finance/openbb-platform.git
cd openbb-platform

Build the Docker Image:

docker build -f build/docker/platform.dockerfile -t openbb-platform:latest .

Run the Docker Container:

docker run --rm -p 8000:8000 -v ~/.openbb_platform:/root/.openbb_platform openbb-platform:latest

By mounting the ~/.openbb_platform directory, this setup saves your API keys and preferences, ensuring they remain accessible each time you run OpenBB in Docker.

Accessing the OpenBB API
Once the container is running, you can access the OpenBB API on localhost:8000. For advanced use, consider customizing port settings or specifying different configuration files using Docker options.

Othe way: By cloning the repository directly

Step 1: Set Up a Python Virtual Environment

Creating a virtual environment is recommended to avoid conflicts with other Python packages.

Create and activate the environment:

python -m venv openbb_env
source openbb_env/bin/activate   # On Windows, use `openbb_env\Scripts\activate`

Upgrade pip and setuptools to ensure compatibility:

pip install --upgrade pip setuptools

Step 2: Install Git
Make sure Git is installed so you can clone the OpenBB repository.

pip install git

Step 3: Clone the OpenBB Repository
Now, pull the source code directly from OpenBB’s GitHub repository.

git clone git@github.com:OpenBB-finance/OpenBB.git
cd OpenBB

Switch to the Desired Branch
If you’re interested in working with the latest developments, switch to the develop branch:

git checkout develop

Step 4: Install Poetry
OpenBB uses Poetry for package management, so it needs to be installed before proceeding.

pip install poetry

Step 5: Run the Developer Installation Script
To complete the setup, use the dev_install.py script to install the core OpenBB platform along with any dependencies.

python dev_install.py

Optional: Install All Extensions and Providers
If you'd like access to all available OpenBB extensions and data providers, add the -e flag:

python dev_install.py -e

Rest of the installation-related docs can be found here

Post-Installation Steps for OpenBB

After completing the installation of the OpenBB platform, whether from source or using another method, you’ll need to ensure that the Python interface is set up correctly. Here’s a step-by-step guide to ensure everything runs smoothly, including how to initiate the REST API.

Step 1: Build the Python Interface
With a new installation or any time you add or remove extensions, you’ll need to build the Python interface. This build process is triggered automatically upon installation, but you can also run it manually if required.

Open a Python session:

python

Import OpenBB to initiate the interface:

from openbb import obb

Exit the Python session after this initialization step:

exit()

Manually Triggering the Build
If you need to rebuild the interface (e.g., after installing new extensions), follow these steps:

import openbb
openbb.build()

After running this, restart the Python interpreter.

Step 2: Start Using the OpenBB Platform
With the environment properly set up, you can now start leveraging OpenBB’s functionality.

from openbb import obb

Step 3: Starting the REST API
If you’re interested in leveraging OpenBB’s REST API for programmatic access to its data and analysis capabilities, here’s how to get it running.

Run the following command to start the REST API:

uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload

This command launches the REST API on port 8000, making it accessible at http://localhost:8000.

Now lets learn some basic syntax. Official Docs here

Key Parameters Across OpenBB Commands

OpenBB’s standardized parameters appear at the start of each function docstring, making it easy to identify required inputs. Here are the essential ones:

provider
symbol
start_date
end_date
date
limit

Let’s dive into each parameter and how to use them in your queries.

Provider: Choosing Your Data Source The provider parameter specifies the data source, allowing flexibility in data selection based on your preferred provider. For example:

historical_prices = obb.equity.price.historical("aapl", provider="alpha_vantage")

If no provider is specified, OpenBB defaults to the first alphabetically installed provider, unless one is defined in the user settings. Available provider coverage can be checked with:

obb.coverage.providers

Symbol: Specifying Your Asset The symbol parameter identifies the asset you want data for. OpenBB accommodates multiple symbol formats and input methods:

Single Symbol

quote = obb.equity.price.quote(symbol="td", provider="fmp")

Multiple Symbols

Using a comma-separated string:

quotes = obb.equity.price.quote("td,schw,jpm,ms", provider="fmp")

Using a Python list:

quotes = obb.equity.price.quote(["td", "schw", "jpm", "ms"], provider="fmp")

Dates: Specifying Timeframes for Data Dates are a fundamental part of most data queries. OpenBB supports both date strings in the "YYYY-MM-DD" format and datetime objects.

Example with date strings:

historical_prices = obb.equity.price.historical(symbol="qqq", start_date="2023-01-10", end_date="2023-01-31", provider="fmp")

Using datetime objects:

from datetime import datetime
start = datetime.strptime("100123", "%d%m%y")
end = datetime.strptime("2023-01-31","%Y-%m-%d")
historical_prices = obb.equity.price.historical("qqq", start_date=start, end_date=end, provider="fmp")

Limit: Restricting Data Quantity The limit parameter controls the number of results returned, helping manage large datasets by limiting the output to the most recent data or from a specified start date.

income = obb.equity.fa.income("AAPL", period="quarter", provider="fmp", limit=4)

Using **kwargs for Flexibility OpenBB commands support additional arguments through **kwargs, allowing easy parameter expansion for complex queries. Here’s how to use them:

kwargs = {"symbol": "msft", "start_date": "2023-01-01", "provider": "polygon"}
historical_prices = obb.equity.price.historical(**kwargs)

Handling Warnings and Unsupported Parameters Each query will warn of invalid parameters, and any unsupported parameter will appear in the warnings field, letting you know how to adjust your request.

data = obb.equity.price.quote("brk-b", provider="fmp", source="bats")
print(data.warnings)  # Expects a warning message

Now let's learn some basic responses. Official Docs here

OpenBB Command Output Structure and Custom OBBject Class
Every command output in OpenBB is an OBBject, a custom class containing the primary result and relevant metadata. Here’s an overview of the OBBject fields and how to work with them.

OBBject Fields

id: A unique UUID identifier for the request.
results: The main data returned from the command.
provider: The data provider used in the request.
warnings: A list of any warnings encountered.
chart: A chart object, if applicable, with visualization capabilities.
extra: Additional metadata about the request, including the request parameters.

Example Usage:

from openbb import obb

# Run a command to get historical price data
data = obb.equity.price.historical("SPY", provider="polygon")

# Print the OBBject for an overview
print(data)

Sample Output:

OBBject

id: 06520558-d54a-7e53-8000-7aafc8a42694
results: [{'date': datetime.datetime(2022, 10, 5, 0, 0), 'open': 375.62, 'high': 37...
provider: polygon
warnings: None
chart: None
extra: {'metadata': {'arguments': {'provider_choices': {'provider': 'polygon'}, 'st...

Converting OBBject Results to Various Formats

OBBject offers methods to easily convert results into different formats:

to_dict(): Converts to a dictionary. Supports various orientations (e.g., "records").
to_df() / to_dataframe(): Converts results to a Pandas DataFrame, ideal for data manipulation in Python.
to_numpy(): Exports results as a Numpy array.
to_polars(): Converts results to a Polars table, useful for performance with large datasets.

Example:

# Convert data to a DataFrame
df = data.to_dataframe()

# Convert data to a dictionary
data_dict = data.to_dict(orientation="records")

Setting Preferred Output Type

You can configure OpenBB to return results in a preferred format by setting the output_type in user preferences. For instance, to always get results as a DataFrame:

obb.user.preferences.output_type = "dataframe"

With these tools, you’ll streamline data handling in OpenBB, making it easy to integrate results directly into your data analysis workflows.

Please prefer official documentation once again here

Conclusion

OpenBB provides a powerful set of fundamental analysis tools that empower retail investors to assess stocks like Apple with professional-level insights. By examining income statements, key ratios, growth trends, and valuations, investors can develop a comprehensive understanding of a company's financial health and its potential for future returns.

Increase your productivity with OpenBB now!

Are you prepared to enhance your investment research? Download OpenBB today and embark on your journey towards making more informed financial decisions. With OpenBB at your fingertips, professional-grade stock analysis tools are merely a command away.

Redefining Financial Analysis with OpenBB: The Power of Open-Source Versus Proprietary Tools

Aditya Deshlahre — Wed, 30 Oct 2024 16:17:20 +0000

In recent years, finance has become increasingly accessible, thanks to a surge in data availability and tools for analyzing it. Once dominated by exclusive proprietary platforms, financial markets are now open to a broader audience, with open-source tools like OpenBB paving the way. OpenBB, an innovative platform for financial research, offers a robust alternative to proprietary solutions, equipping traders, analysts, and researchers with a powerful, flexible set of tools. This article delves into the unique advantages OpenBB offers, highlighting its open-source flexibility and adaptability that position it as a transformative force in democratizing financial analysis.

Key Advantages of OpenBB Over Proprietary Tools

Comprehensive Research Hub: Unlike proprietary platforms that often limit access to essential data, OpenBB provides extensive financial data and advanced analytics tools in one streamlined platform, ensuring users can conduct thorough research without barriers.
Data Integration Made Easy: While proprietary tools may impose strict data limitations, OpenBB allows seamless integration of various data sources, enriching investment decisions and enhancing monitoring workflows.
Powerful AI Insights: Proprietary tools may restrict AI capabilities or charge extra for advanced features, but OpenBB leverages AI-driven analysis to empower users with smarter, data-backed investment strategies without additional costs.
Customizable Visualizations: Proprietary platforms often offer rigid reporting formats. In contrast, OpenBB allows users to tailor visual reports and dashboards, providing a clearer view of market trends and ensuring the flexibility to meet diverse needs.
Optimized for Teams: Many proprietary tools come with high licensing fees for team collaboration features. OpenBB, however, facilitates effortless collaboration with tools designed for both individual use and team efficiency, free for individual users.

Dashboard:

It has a very comprehensive dashboard with OpenBB copilot at the right and data connection, templates, dashboard and shared files at the left.

In the center dashboard, we have a Transcript of a selected asset class.

Just below the transcripts, we have a chart option and statistics and just below that we have a comprehensive watchlist.

All Your Data

Seamlessly upload structured or unstructured files, integrate with proprietary systems, or utilize our packaged data to build a unified view for in-depth analysis.

Effortless Data Integration: Upload structured or unstructured data to streamline your research and analysis.
Flexible Import Options: Connect with proprietary systems or import packaged data to enrich insights.
Unified Data View: Build a comprehensive perspective by consolidating diverse data sources in one place.
In-Depth Analysis: Leverage a complete dataset for more accurate, holistic investment insights.

AI Copilot

OpenBB’s Copilot empowers you to unlock workflows, gain insights, and automate processes effortlessly. Built for versatility, it adapts to any type of data with precision and reliability.

option to BRING YOUR OWN LLM

AI-Powered Guidance: Use the Copilot to streamline workflows, uncover insights, and automate tasks with ease.
Adaptable Intelligence: Built to handle all data types, ensuring reliable and precise responses.
Interactive Chat Interface: Engage in a responsive, conversational format for real-time investment and research answers.
Bring Your Own LLM: Integrate your preferred language model for a fully tailored AI experience.

Flexible Interface

Easily design and organize your workspace with custom charts, graphs, tables, notes, images, PDFs, and web embeds. Create a layout tailored to streamline your unique workflow.

Personalized Layouts: Design a workspace that aligns perfectly with your workflow and research style.
Versatile Display Options: Arrange charts, graphs, tables, notes, images, PDFs, and even web embeds to optimize information flow.
Streamlined Efficiency: Organize your dashboard for quick access to essential insights and data visualizations.
Tailored for Productivity: Build a workspace that adapts to your specific investment and analysis needs.

Solution for ENTERPRISES

Empower your team with next-level enterprise tools! Perfect for investment analysis, due diligence, and capital allocation—secure, compliant, and built for collaboration.

Enterprise-Grade Security: Ensure data privacy and regulatory compliance with robust security measures.
Collaborative Workspace: Foster teamwork with tools designed for seamless collaboration across teams.
Advanced Analysis Tools: Access powerful resources tailored for in-depth investment analysis, due diligence, and capital allocation.
Scalable Solutions: Adapt to your organization’s unique needs with a flexible, scalable platform built for growth.

Safe ecosystem for your data.

@openbb_finance Compliant & Secure: We prioritize strict compliance and security to keep your data safe and sound. SOC 2 Type 2 certification is ongoing.

Robust Security Measures: Prioritize your data's safety with industry-leading security protocols.
Compliance First: Ensure adherence to regulatory standards with ongoing SOC 2 Type 2 certification.
Trustworthy Environment: Build confidence in your data management with a focus on compliance and security.
Peace of Mind: Operate in a secure ecosystem where your sensitive information is protected and managed responsibly.

OpenBB Finance is now available at Mobile Look At Here

checkout amazing logs Here

oss.gg hackathon Experience Sharing.

Aditya Deshlahre — Wed, 30 Oct 2024 15:16:09 +0000

This year 2024 on month of October which is a month of open source called hacktober fest started the same as every year and Formbrick again came with good stuff called oss.gg a gamified hackathon.

Where competition is heavy literally heavy there was almost 4500+ players playing. For RAFFLES: To win at least a price since prices were very lucrative :)

And this brick price is very important......

This is enough about my oss.gg now about my stuff.

How I got started.

Created my first-ever onboarding video for papermark while so casing all its functionality.

PR Link

and the rest of the month passed in solving side quests and a little bit of issues only.

Note: Initially I thought code contributions would overpower me with the heavy points. But it wasn't it. So next time solve the side quest first :)

Overall I improved in writing though (not article but code)

A big Thanks to all the repo maintainers for being so calm and handler this rush. And take things positively.

7 repos were very good where participating was:

dub.co
Formbricks
OpenBB Finance
Hanko
Unkey
Twenty
Papermark

I tried to maintain consistency across the hackathon CODE + SIDE Quest.

Stress of scoreboard

The leaderboard updates in real time, allowing participants to track their rankings and see their progress. For those with a competitive edge, the dashboard includes links to all code issues and side quests for maximizing points, along with a playful guide on "How to Make 1050 Points in 5 Minutes without Touching Code."

Community

The Discord community serves as an active space for collaboration, advice, and support. It’s an excellent way to connect with others, get real-time assistance, and stay informed on event updates.

Final Thoughts

jobenjada idea is very good and thanks to all other repo members for participating.
oss.gg bot is amazing
really helpful maintainers
next time please keep the code issue as a priority please
thanks for making my GitHub look more green

had a really great time :)

Transform Your Customer Relationships with the Leading Open Source CRM: Twenty!

Aditya Deshlahre — Wed, 30 Oct 2024 01:37:38 +0000

In today’s competitive landscape, effective customer relationship management is crucial. Twenty CRM is a powerful platform that simplifies customer interactions, strengthens relationships, and ensures data security and privacy.

Quick Walkthrough Video

What is Twenty CRM?

Twenty CRM is an open-source platform redefining customer relationship management for modern businesses. Built to streamline CRM processes, Twenty combines essential features and an intuitive design to support teams in handling customer relationships seamlessly. Unlike legacy CRM systems, which often become cumbersome and expensive over time, Twenty is designed to be agile, cost-effective, and customizable to the specific needs of any organization.

Note : We have Dark Mode :)

Features of Twenty CRM

Contact Management: Efficiently store and manage customer data. Learn more.
Custom Objects: Create and customize objects to fit your business needs. Details.
Custom Fields: Tailor data fields to capture and organize information specific to your operations. Understand more.
Kanban & Table Views: Optimize your workflow with flexible Table Views and Kanban Views.
Pipeline Visualization: Get a clear view of your processes with customizable views. Explore views.
Email Integration: View the emails of a specific customer or company within your workspace. Integrate now.
Notes: Create detailed notes for each record to share knowledge more effectively. Add notes.
Tasks: Schedule tasks to track customer interactions. See how.
API & Webhooks: Connect to other apps and automate workflows with API and Webhooks. Start integrating.

WorkSpaces

There are different workspaces for effect management

- People

- Companies

- Opportunities

- Tasks

- Notes

- Rockets

- Workflows

Documentation

Documentation becomes very necessary when it comes to usability over all as User/Developer

- User Guide

User Guide for Twenty is your go-to resource for mastering this open-source CRM. Here’s what you can explore:

Getting Started: Familiarize yourself with the basics, including Twenty’s features, benefits, system requirements, and community involvement opportunities.
Objects: Learn how to effectively use standard and custom objects within your workspace to enhance data management capabilities.
Functions: Discover how to seamlessly connect Twenty to your other tools, streamlining your workflow.
Other Tips: Access valuable insights on user and workspace management, along with personalization settings to tailor the platform to your needs.
This guide is designed to empower you to leverage Twenty CRM to its fullest potential!

- Developers Guid

If you’re eager to dive deeper into Twenty CRM, our comprehensive developer documentation is here to help:

Local Setup: Simplified guide for running Twenty CRM on your machine.
Self-Hosting: Detailed instructions for hosting Twenty on your own server, giving you full control over your CRM environment.
Extending the Platform:
- Rest APIs: For straightforward integrations.
- GraphQL APIs: For more powerful integration options.
Contributing: Welcomes bug reports and feature requests on GitHub or Discord.
Frontend Development Resources:
- Insights on Storybook.
- Guidance on Figma.
- Best practices for React.
Backend Development Insights:
- Information on NestJS.
- Utilizing custom objects.
- Working with queues.

Explore our developer docs to enhance your experience with Twenty CRM!

Integration

We support integration

Airtable
Stripe
Zapier
Windmill

Didn't find the integration of your choice? Request here

DataModle and Visualization

You can see your workflow visually since we have different connections and workflows between existing workspaces. So it is easy to maintain and explain itself in team.

API & WEBHOOKS and Functions

Easily manage the distribution of API keys and Webhook URLs from a centralized location. Set up Webhook endpoints to receive real-time notifications for asynchronous events, ensuring you stay informed and responsive to changes as they occur.

Creating custom function with code is easier now. You code test run the function code which eventually can be implemented in your workflow.

The Open-Source Advantage

As an open-source tool, Twenty CRM gives companies complete control over their CRM system, free from costly subscription models and limited customization. The active community behind Twenty continuously contributes to improvements, making it easy for users to find solutions, suggest new features, and even directly shape the platform's future. An open roadmap fosters collaboration, allowing users to participate in feature discussions and contribute code to help build the CRM they envision.

A Self-Hostable SaaS for Full Ownership #ownyourdata

Twenty CRM is designed to be self-hostable, which means organizations can install, configure, and control it on their own servers, offering the best of both worlds: SaaS-like features with the control of self-hosting. This approach appeals to companies that prioritize privacy and data ownership, as well as to those who prefer to manage costs internally. For teams looking to avoid dependency on external software providers, self-hosting with Twenty CRM can be a game-changer.

Why Twenty CRM Stands Out

Twenty CRM is built for adaptability. With support for custom data objects, GraphQL and REST API integration, and flexible workflow configurations, it seamlessly aligns with diverse business needs. Key features include task management, reminders for client follow-ups, and kanban views that simplify project management. For developers and data engineers, the platform’s flexibility eases customization, while its clean, user-focused design helps sales teams navigate tasks more efficiently, avoiding the slowdowns common in older CRM systems.

Roadmap and Community Discussions

The Twenty CRM community actively participates in shaping the platform’s roadmap, which includes several exciting initiatives:

Integrations and API Enhancements: Ongoing projects focus on improving data integration and supporting new tools, such as Google Analytics, Slack, and more real-time data access through APIs.
Localization and Multi-language Support: With global use in mind, Twenty CRM’s community has proposed multi-language support to enhance accessibility for teams around the world.
Advanced SSO Options: With plans to support OpenID Connect, the platform aims to offer secure, scalable single sign-on features for seamless authentication.

By staying involved in GitHub discussions, users can engage directly with contributors, help prioritize new features, and offer feedback on functionality, ensuring Twenty CRM continues to evolve to meet the needs of its diverse user base.

In sum, Twenty CRM stands out for its open-source foundation, self-hosting capabilities, and agile, community-driven approach, making it a leading choice for organizations seeking a flexible and powerful CRM solution.

Much more is waiting for you! Start using Twenty.com

Complete Guide to Self-Hosting Twenty CRM

Aditya Deshlahre — Tue, 29 Oct 2024 22:59:46 +0000

Twenty CRM is a cost-effective, open-source CRM solution that empowers businesses to manage customer relationships and sales independently by hosting the system on their own servers. This provides data privacy, customization options, and cost savings, ideal for small to medium-sized businesses.

Open-source CRM designed for self-hosting, giving businesses full control over customer data and processes.
Eliminates recurring fees, making it a cost-effective alternative to traditional CRMs.
Ensures data privacy and security by allowing businesses to host the CRM on their own infrastructure.
Provides flexibility for customization to meet specific business needs.
Ideal for small to medium-sized businesses to manage sales, customer interactions, and lead tracking efficiently.

Choosing Twenty CRM?

Twenty CRM is an affordable, self-hosted CRM solution that offers essential customer management and sales tools with the flexibility, control, and scalability that growing businesses need.

Self-hosted, budget-friendly CRM designed for small businesses and startups.
Provides core CRM functionalities with full control and customization options.
Avoids subscription fees, supporting data privacy and independence.
Built on an open-source framework, offering scalability as businesses expand.
Ideal for tailoring the platform to fit specific operational needs.

This guide will provide a step-by-step walkthrough for setting up (Self-hosting) and customizing Twenty CRM on your own infrastructure.

before that if you want a quick look at what the final self-hosted Twenty looks like. Check out this YouTube Video : )

Let's get started with self-hosting here.......

Prerequisites

Before getting started, ensure you have the following:

Docker Basics: Some knowledge of Docker and Docker Compose, since the setup relies on Docker containers.
PostgreSQL and Redis: Installed and ready on your server if not already configured.
Domain and SSL Certificate: A domain and SSL for secure access (optional for local testing).
Email Account for Notifications: An SMTP-compatible email account, such as Gmail.
OpenSSL: Needed for creating secure tokens.
Prepare the Server Environment:
- CPU: 2+ cores
- Memory: 4GB or more
- Storage: SSD with at least 50GB free space
- Operating System: Ubuntu 20.04+ or any Docker-compatible OS

Step 01: Clone & Configure Twenty CRM

Clone the Repository to Server:

git clone https://github.com/twentyhq/twenty.git

cd twenty

Download Sample Environment (.env) and Docker (docker-compose.yml) Files:

curl -o .env https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/.env.example

curl -O https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/docker-compose.yml

Step 02: Set Up Essential Environment Variables

Edit the .env file to configure connections for all services. Here are some example variables, organized by component.

Frontend Environment Variables

These variables are essential for configuring the front end of your CRM instance:

REACT_APP_SERVER_BASE_URL=http://localhost:3000       # Backend server URL
GENERATE_SOURCEMAP=false                              # Disable source maps for production
CHROMATIC_PROJECT_TOKEN=<your_chromatic_token>        # Obtain this from Chromatic for versioning UI changes

Backend Environment Variables

Define these variables to set up database connections, server settings, and secure tokens:

PG_DATABASE_URL=postgres://user:password@localhost:5432/database    # PostgreSQL connection URL
REDIS_URL=redis://localhost:6379                                    # Redis connection URL
SERVER_URL=http://localhost:3000                                    # Base URL for the backend
ACCESS_TOKEN_SECRET=<random>                                        # Secure token for access management
CACHE_STORAGE_TTL=604800                                            # Cache TTL (7 days in seconds)

Security Token Generation

For enhanced security, generate unique tokens for each of the following:

openssl rand -base64 32

Use the generated strings to populate the secure token variables in .env:

ACCESS_TOKEN_SECRET=<token_1>
LOGIN_TOKEN_SECRET=<token_2>
REFRESH_TOKEN_SECRET=<token_3>
FILE_TOKEN_SECRET=<token_4>

Step 03: Enable Messaging and Calendar Synchronization

To streamline customer engagement, set up messaging and calendar sync by scheduling these recurring tasks:

# These are commands run it on the server 
yarn command:prod cron:messaging:messages-import
yarn command:prod cron:messaging:message-list-fetch
yarn command:prod cron:calendar:calendar-event-list-fetch

These commands will import all Gmail messages and calendar events, centralizing customer interactions in one location.

Step 04: Set Up Email Notifications and File Storage

Configure email and file storage to enable notifications and manage files effectively.

Email Configuration

Gmail is supported for email, though any SMTP-compatible provider will work:

# Edit this is .env file
EMAIL_SMTP_HOST=smtp.gmail.com 
EMAIL_SMTP_PORT=465
EMAIL_SMTP_USER=<your_email>
EMAIL_SMTP_PASSWORD=<your_app_password>

File Storage Options

For local file storage, use these settings:

# Edit this is .env file
STORAGE_TYPE=local
STORAGE_LOCAL_PATH=.local-storage

For scalable storage on Amazon S3, use the following configuration:

Alternatively, you can use MinIo in the save server and configure it too

# Edit this is .env file
STORAGE_S3_REGION=us-east-1
STORAGE_S3_NAME=my-bucket
STORAGE_S3_ACCESS_KEY_ID=<access_key>
STORAGE_S3_SECRET_ACCESS_KEY=<secret_key>

Step 05: Deploy with Docker Compose

To launch Twenty CRM, use Docker Compose:

Start the Docker Containers: Run Twenty CRM in detached mode:

# This is a command to run on the server 
docker-compose up -d

Verify: Access the app at http://localhost:3000. For production, update SERVER_URL to your domain in .env, then restart:

# This is a command to run on the server 
docker-compose down && docker-compose up -d

Step 06: Configure External Access

To make your CRM accessible over the internet, set up your domain and enable SSL. Follow these instructions:

Without a Reverse Proxy

For direct access:

# Edit this is .env file
SERVER_URL=http://your-domain-or-ip:3000

With a Reverse Proxy

For secure HTTPS access through a reverse proxy:

# Edit this is .env file
SERVER_URL=https://your-domain-or-ip

After updating SERVER_URL, restart the containers:

To restart the container use the below command

# This is a command to run on the server 
docker-compose down && docker-compose up -d

Troubleshooting Common Issues

A: Unable to Login

A frequent issue reported on Discord is the “Unable to login” error.

If you’re facing login problems, try executing the following commands:

# These are commands run it on the server 
docker exec -it twenty-server-1 yarn
docker exec -it twenty-server-1 npx nx database:reset

After completing these steps, restart the containers with:

# These are commands run it on the server 
docker-compose down
docker-compose up -d

B: Connectivity Issues with a Reverse Proxy

Ensure that SERVER_URL in your .env file matches the URL for external access. Double-check that your reverse proxy settings are correctly forwarding requests to the Twenty server, then restart both the reverse proxy and Twenty containers.

C: Authentication Callback Issues

Errors often arise from misconfigurations with Google or Microsoft SSO. Verify that the callback URLs in your .env file exactly match those in your API credentials.

D: Optimizing Performance

Adjust Redis cache settings to manage higher traffic, and fine-tune PostgreSQL for improved performance.

Scaling Your Deployment

For larger setups, consider the following:

Load Balancing: Use tools like NGINX or HAProxy to distribute traffic across multiple instances.
Horizontal Scaling: Run multiple backend containers to manage higher workloads.
Database Replication: Configure read replicas for PostgreSQL to support high query volumes.
Redis Clustering: Set up Redis clusters to handle larger datasets and improve caching speed.

Extrazzzzzzzzz........

Integrating Additional Tools

Enhance Twenty CRM by integrating with third-party tools:

Google Analytics: Monitor CRM usage with Google Analytics.
Zapier: Automate workflows between Twenty CRM and other applications.
Slack/Webhooks: Configure webhooks for instant notifications in Slack or other platforms.

Advanced Configuration

To unlock additional capabilities, Twenty CRM supports AI integrations, telemetry, and monitoring.

Enabling AI Features

If you’re using OpenAI for customer insights, include the following in your configuration:

# Edit this is .env file
OPENAI_API_KEY=your_openai_key

Telemetry and Error Tracking

Set up Sentry to log errors and monitor performance by adding:

# Edit this is .env file
SENTRY_DSN=https://your_key@your_project.ingest.sentry.io/your_id
SENTRY_ENVIRONMENT=production

Conclusion

Following this guide, you should have a fully operational, self-hosted instance of Twenty CRM, equipped to manage your business's customer relationships. For additional help, consider joining Twenty's active Discord community or checking the GitHub discussions for further support and updates.

Own Your Data Happy Hosting :)

Hacktoberfest🎃 side hack: Write code, win a Macbook💻, PS5🎮 or iPhone 16📱

Aditya Deshlahre — Thu, 03 Oct 2024 00:10:15 +0000

Hello Open Sourcerer👋!

Hacktoberfest 2024 is here. Hence oss.gg came with an amazing gamified playground for you to get started with your very first open contribution.

oss.gg is a month-long program run by open source startup where you can complete Side Quest, code and non-code contributions to get points each point is a lottery ticket lottery that happens on the 31st of October 2024 🎃 sign up for the kick-off stream here.

Q: Gamified what? some prizes...? 🎁
A: Hell lot of prizes, For example, you can win these

Macbook Pro 2023 M3 14 💻
Macbook Air 2023 M3 15 💻
iPhone 16 with 512GB 📱
PlayStation 5 🎮
AirPods Pro 3rd Gen (x2) 🎧
EPOMAKER EP84 ⌨️
EPOMAKER x AULA F75 (x2) ⌨️
a brick 🧱

So Continuing,

This year (2024) we have 7 repositories that are featured in oss.gg where you can contribute to issues earn points and increase your chances of winning those amazing prizes.

1. FormBricks

Tech Stack: TypeScript, MDX, JavaScript, and Dockerfile

For UI/UX Enthusiasts and Survay Creators/Marketers

Formbricks is an open-source platform for building and analyzing surveys, offering in-app, website, email, and link-based feedback collection. It features a no-code editor with customizable templates, targeting, and triggers to display surveys to specific users at the right moments. Integration with tools like Slack, Notion, and Zapier enhances workflow, while built-in analytics provide insights for improving user experiences. Available as a cloud service with a free plan, it also supports self-hosting via Docker. Built with modern frameworks like React and Next.js, Formbricks is fully transparent and self-hostable under an open-source license.

How to Contribute

New Integrations: Create connections with external tools such as Panora and Make.
Feature Enhancements: Introduce additional template formats or advanced response real-time analytics features.
Bug Fixes and Performance Optimization: (EDGECASES) Contribute to making Formbricks more efficient and dependable.
Documentation and Tutorials: Produce instructional content to assist others in implementing Formbricks within their projects.

2. OpenBB

Tech Stack: Python

For Data analytics and finance Researchers

OpenBB is an open-source platform designed to simplify access to financial data by integrating various data providers through a single API. It allows users to retrieve financial information from multiple sources without the need for complex integrations, making it easier for developers, analysts, and financial professionals to create data-driven applications. The platform supports extensibility, enabling users to add new data providers as needed. OpenBB’s mission is to remove barriers to financial data access and streamline the process for building financial tools and strategies.

How to Contribute

Data Source Integration: Incorporate new financial data providers or APIs to enhance the platform’s offerings.
Feature Enhancements: Create innovative analytical tools or refine existing ones to improve user experience.
Bug Fixes: Collaborate to boost the platform’s stability and reliability.
Documentation and Tutorials: Develop guides and resources to help users maximize their use of OpenBB Terminal.

3. Unkey

Tech Stack: TypeScript, Go, React, Next.js and Turborepo

For Dev tooling, deployment operations and Devops managment

Unkey is an API management platform that focuses on simplicity, offering features like API key management, standalone rate limiting, and caching for large language models (LLM). It provides per-key analytics and customizable expiration, allowing businesses to monitor API usage, rate limits, and manage key metadata. Unkey’s tech stack includes serverless infrastructures, enabling it to scale efficiently while avoiding the need for a traditional gateway for smaller businesses.

How to Contribute

Feature Enhancements: Introduce new types of feature flags or targeting rules to improve functionality.
SDK Development: Build SDKs for additional programming languages to expand integration capabilities.
Dashboard Improvements: Upgrade the web dashboard to enhance user experience and usability.
Documentation and Examples: Create detailed guides and code examples to assist users in leveraging Unkey's features effectively.

4. papermark

Tech Stack: TypeScript

For Privacy-Conscious Document Sharers and Security-Focused Developers

Papermark.io is an open-source document-sharing alternative to DocSend, offering built-in analytics and support for custom domains. It allows users to securely share documents via custom links and provides the ability to add custom branding, including custom domains. Papermark’s analytics feature offers insights into document engagement, with plans for page-by-page tracking in the future. As a self-hosted, open-source platform, users have full control, enabling them to modify and extend the functionality according to their needs. It’s ideal for businesses looking for a flexible, customizable document-sharing solution without relying on proprietary platforms.

How to Contribute

Feature Development: Add tagging, categorization, or annotation capabilities to enhance document organization and accessibility.
Browser Extensions: Create extensions for popular browsers that allow users to save content directly to Papermark.
Mobile App Development: Develop a mobile application to facilitate easier access to documents on the go.
Documentation and Localization: Enhance existing documentation and translate the platform into additional languages to reach a broader audience.

5. 20 (twenty CRM)

Tech Stack: React, Apollo, GraphQL Codegen, Recoil, TypeScript, Jest, Storybook, Yarn, and Craco

For Business dashboards and Team management Developers

Twenty.com is an open-source Customer Relationship Management (CRM) platform that offers a flexible and customizable solution for managing customer relationships. It provides tools like custom data modeling, Kanban views for task management, advanced search capabilities, and support for notes, tasks, attachments, and activity tracking. It also features robust API support, including GraphQL and REST, allowing easy integration with external systems.

How to contribute

Module Development: Build new modules tailored for sales, marketing, or customer support functions.
Integration with Third-Party Services: Create integrations with email providers, social media platforms, or analytics tools to enhance functionality.
UI/UX Improvements: Refine the user interface to deliver a more intuitive and enjoyable user experience.
Documentation: Contribute to user guides and developer documentation to assist with onboarding and usage.

6. Hanko

Tech Stack: Go, TypeScript and Svelte

For Authentication and security related (API) Developers

Hanko is an open-source authentication solution that eliminates passwords by enabling secure passkey-based logins. Designed for quick integration through Hanko Elements web components, it offers a cloud-native, API-first architecture suitable for self-hosting or utilizing Hanko Cloud. As a member of the FIDO Alliance, Hanko capitalizes on the evolving support for passkeys across devices and browsers, enhancing user experience with features like Touch ID and Face ID. This positions Hanko as a leading choice for modern authentication needs.

How to Contribute

Feature Development: Introduce support for a wider array of authentication methods, such as biometric options or multi-factor authentication.
Security Enhancements: Perform comprehensive security audits to identify vulnerabilities and refine existing protocols to bolster system integrity.
Client Libraries: Create Software Development Kits (SDKs) for various programming languages to facilitate easier integration of Hanko's authentication solutions.
Documentation: Produce thorough setup guides and API documentation to assist developers in implementing Hanko effectively within their applications.

7. dub.co

Tech Stack: Tech Stack: Next.js, TypeScript, Tailwind, Upstash, Tinybird, PlanetScale, NextAuth.js and BoxyHQ

For UI/UI Enthusiasts and Marketers/Creaters

Dub.co is an open-source link management infrastructure designed for modern marketing teams. It offers features such as advanced analytics, branded links, and personalized QR codes, enabling users to create and manage links efficiently. With a focus on team collaboration and an intuitive user experience, Dub.co helps businesses optimize their marketing efforts through robust tracking and reporting capabilities.

How to Contribute:

Feature Development: Create new functionalities, such as custom domain support, QR code creation, or social media connections.
Documentation: Update or broaden the current documentation to help newcomers get acclimated easily.
Bug Fixes: Assist in identifying and resolving bugs to enhance the platform’s reliability.
UI/UX Enhancements: Improve the design and user experience for better navigation and usability.

Some F&Q 🕹️

Q: how to submit a non-code contribution via GitHub
A: Steps to Follow : ✅

open an issue for your contribution. Use the side quest template.
comment with /assign to assign yourself
open a PR where you reference your issue
in each repo you'll find a folder called "oss.gg hackathon"
in each folder, there's one .txt file for each side quest. here we keep track of each submission
add a new entry with the following info: Your GitHub name, a UTC timestamp, and a link with your proof of contribution.
the project maintainer will add the corresponding points to the issue, review the PR and once it's merged, you'll be awarded your points automatically.
don't forget to check your current points at oss.gg/[yourGitHubUsername]

Q: How does the lottery work? 🎲
A: for every contribution you get points each point is one lottery ticket all points collected in all repos are same the more points, the higher the chance to win but players with 1 point can also win a Mac

Q: Can I win multiple prizes? 🎁
A: you wish

Q: Can I rig the system? 💻
A: play fair to stay in the game cheat or spam to get disqualified

The oss.gg Hackathon 2024 is not merely a competition; it’s a vibrant showcase of open-source collaboration and creativity. By participating in these projects, you enhance your skill set while contributing to the development of tools that serve communities around the globe.

What you are waiting for.......

A lot of Side Quest and challenges, No-Code, and Code issues are waiting for you so what you are waiting for get started here.

What repository are you most excited to contribute to this Hacktoberfest x oss.gg? Let me know in the comments below!