index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/src | petrpan-code/Shopify/polaris/polaris.shopify.com/src/styles/mixins.scss | @import './variables.scss';
@mixin dark-mode {
:global(.dark-mode) & {
@content;
}
}
@mixin custom-scrollbars {
&::-webkit-scrollbar {
width: 3px;
}
&::-webkit-scrollbar-track {
background-color: transparent;
}
&::-webkit-scrollbar-thumb {
background: transparent;
border-radius: va... | 1,400 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/src | petrpan-code/Shopify/polaris/polaris.shopify.com/src/styles/variables.scss | $pageMaxWidth: 1240px;
$breakpointMobile: 500px;
$breakpointTablet: 768px;
$breakpointDesktopSmall: 1040px;
$breakpointDesktop: 1400px;
$breakpointDesktopLarge: 1600px;
// NOTE: Prettier messes with the comments for some reason
// prettier-ignore
$notMarginConsideredHarmful:
// Extend the current selector
'&'
/... | 1,401 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/src | petrpan-code/Shopify/polaris/polaris.shopify.com/src/utils/hooks.ts | import React, {useEffect, useRef, useState, useCallback} from 'react';
import throttle from 'lodash.throttle';
import {useRouter} from 'next/router';
import {ParsedUrlQueryInput} from 'querystring';
const COPY_TO_CLIPBOARD_TIMEOUT = 2000;
export const useThrottle = (cb: Function, delay: number) => {
const cbRef = ... | 1,402 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/src | petrpan-code/Shopify/polaris/polaris.shopify.com/src/utils/markdown.mjs | import yaml from 'js-yaml';
export const parseMarkdown = (inputMarkdown) => {
const readmeSections = inputMarkdown.split('---');
const frontMatterSection = readmeSections[1];
const readmeSection = readmeSections.slice(2).join('---');
// Extract front matter
const frontMatter = yaml.load(frontMatterSection);... | 1,403 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/src | petrpan-code/Shopify/polaris/polaris.shopify.com/src/utils/various.ts | import siteJson from '../../.cache/site.json';
import {PatternFrontMatter, SiteJSON} from '../types';
import type {BreakpointsAlias} from '@shopify/polaris-tokens';
import {breakpointsAliases} from '@shopify/polaris-tokens';
export function isObject(value: any) {
const type = typeof value;
return value != null && ... | 1,404 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/scripts/preversion.js | const {execSync} = require('child_process');
const getReleasePlan = require('@changesets/get-release-plan').default;
const run = async () => {
const {releases} = await getReleasePlan(process.cwd());
const packages = releases.map((release) => release.name);
const execOpts = {stdio: 'inherit'};
execSync(
`... | 1,405 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/CHANGELOG.md | # Changelog
## 15.0.3
### Patch Changes
- Updated dependencies [[`23055adcf`](https://github.com/Shopify/polaris/commit/23055adcfa97decbfbc51924bd121d1dae76ac6f)]:
- @shopify/polaris-tokens@8.1.0
## 15.0.2
### Patch Changes
- Updated dependencies [[`73b1d5d2c`](https://github.com/Shopify/polaris/commit/73b1d5d2... | 1,406 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/README.md | # Stylelint Polaris
Collection of Stylelint configs and rules that promote Polaris Design System adoption and coverage
[Stylelint Polaris documentation](https://polaris.shopify.com/tools/stylelint-polaris)
| 1,407 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/index.js | const {
createVar,
getThemeVarNames,
themeDefault,
} = require('@shopify/polaris-tokens');
const disallowedUnits = [
'px',
'rem',
'em',
'%',
'ex',
'ch',
'lh',
'rlh',
'vw',
'vh',
'vmin',
'vmax',
'vb',
'vi',
'svw',
'svh',
'lvw',
'lvh',
'dvw',
'dvh',
'cm',
'mm',
'Q',
... | 1,408 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/package.json | {
"name": "@shopify/stylelint-polaris",
"description": "Polaris Design System Stylelint tooling",
"version": "15.0.3",
"private": false,
"license": "MIT",
"author": "Shopify <dev@shopify.com>",
"repository": "https://github.com/Shopify/polaris",
"bugs": {
"url": "https://github.com/Shopify/polaris/i... | 1,409 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/test-types.d.ts | // eslint-disable-next-line @typescript-eslint/consistent-type-imports
declare let testRule: import('jest-preset-stylelint').TestRule;
| 1,410 |
0 | petrpan-code/Shopify/polaris | petrpan-code/Shopify/polaris/stylelint-polaris/tsconfig.json | {
"extends": "@shopify/typescript-configs/node-base",
"compilerOptions": {
"allowJs": true,
"checkJs": true,
"composite": true,
"emitDeclarationOnly": true,
"outDir": "dist",
"rootDir": "./"
},
"files": ["./test-types.d.ts"],
"exclude": ["node_modules", "dist"],
"references": [{"path... | 1,411 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/at-rule-disallowed-list/README.md | ## At rule disallowed list plugin
The purpose of this plugin is to disallow usages of the defined at-rules.
## How to use
### Options
```ts
interface PrimaryOptions {
/**
* A map of at-rule names and disallowed at-rule identifiers represented as a list
* of regular expressions or string literals.
*/
[a... | 1,412 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/at-rule-disallowed-list/index.js | const stylelint = require('stylelint');
const {matchesStringOrRegExp, isRegExp, isString} = require('../../utils');
const ruleName = 'polaris/at-rule-disallowed-list';
const messages = stylelint.utils.ruleMessages(ruleName, {
/**
* @type {stylelint.RuleMessageFunc}
*/
rejected: (atRuleName, atRuleParams) =... | 1,413 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/at-rule-disallowed-list/index.test.js | const {messages, ruleName} = require('.');
const disallowedIncludeRegExp = /^([\w-]+\.)?disallowed-include($|\()/;
const disallowedMixinRegExp = /^disallowed-mixin($|\()/;
testRule({
ruleName,
plugins: [__dirname],
config: {
// Using a RegExp ensures we disallow `@mixin id` and `@mixin id()`
// https://... | 1,414 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/coverage/index.js | const stylelint = require('stylelint');
const {isPlainObject} = require('../../utils');
const coverageRuleName = 'polaris/coverage';
/**
* @typedef {import('stylelint').ConfigRules} StylelintConfigRules
* @property {string} message - Message appended to the warning in place of the default category message
*/
/**... | 1,415 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/coverage/index.test.js | const path = require('path');
const {ruleName} = require('.');
const config = {
colors: [
{
'color-named': 'never',
'color-no-hex': [
true,
{message: 'Appended Stylelint rule config message'},
],
},
{
message: 'Appended category rule config message',
},
],
... | 1,416 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-allowed-list/README.md | ## Custom property allowed list plugin
The purpose of this plugin is to ensure that we're following our established conventions for Polaris custom properties, and only using custom properties that are generated Polaris tokens.
### Enforced Rules
- If a `--p-*` custom property is used it must match an existing Polari... | 1,417 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-allowed-list/index.js | const stylelint = require('stylelint');
const valueParser = require('postcss-value-parser');
const {
vendorUnprefixed,
matchesStringOrRegExp,
isCustomProperty,
isRegExp,
isString,
} = require('../../utils');
const ruleName = 'polaris/custom-property-allowed-list';
const messages = stylelint.utils.ruleMessa... | 1,418 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-allowed-list/index.test.js | const {getThemeVarNames, themeDefault} = require('@shopify/polaris-tokens');
const {messages, ruleName} = require('.');
const themeVarNames = getThemeVarNames(themeDefault);
/*
--p-* Tokens are to be defined in polaris-tokens.
- Defining custom properties with this prefix anywhere else is disallowed
- Usage o... | 1,419 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-disallowed-list/README.md | ## Custom property disallowed list plugin
### Options:
```ts
interface PrimaryOptions {
/**
* A list of regular expressions or string literals that match disallowed custom properties.
*/
disallowedProperties?: (string | RegExp)[];
/**
* A map of properties and their disallowed custom properties represe... | 1,420 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-disallowed-list/index.js | const stylelint = require('stylelint');
const valueParser = require('postcss-value-parser');
const {
vendorUnprefixed,
matchesStringOrRegExp,
isCustomProperty,
isRegExp,
isString,
} = require('../../utils');
const ruleName = 'polaris/custom-property-disallowed-list';
const messages = stylelint.utils.ruleMe... | 1,421 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/custom-property-disallowed-list/index.test.js | const {messages, ruleName} = require('.');
const config = [
{
disallowedProperties: ['--p-foo', /--p-bar/],
disallowedValues: {
'/.+/': ['--p-foo', /--p-bar/],
},
},
];
testRule({
ruleName,
plugins: [__dirname],
config,
accept: [
{
code: '.a { --p-foo-bar: red; }',
descri... | 1,422 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/declaration-property-value-disallowed-list/index.js | const stylelint = require('stylelint');
const {
isRegExp,
isString,
validateObjectWithArrayProps,
} = require('../../utils');
const ruleName = 'polaris/declaration-property-value-disallowed-list';
/**
* @typedef {{
* [property: string]: string | RegExp | (string | RegExp)[]
* }} PrimaryOptions
*/
/**
*... | 1,423 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/declaration-property-value-disallowed-list/index.test.js | const {ruleName} = require('.');
const config = {
'font-weight': [/(\$.*|[0-9]+)/],
};
testRule({
ruleName,
plugins: [__dirname],
config,
customSyntax: 'postcss-scss',
accept: [
{
code: '@font-face { font-weight: 400; }',
description: '@font-face descriptors are ignored',
},
],
re... | 1,424 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/global-disallowed-list/index.js | const stylelint = require('stylelint');
const {isRegExp, isString, matchesStringOrRegExp} = require('../../utils');
const ruleName = 'polaris/global-disallowed-list';
const messages = stylelint.utils.ruleMessages(ruleName, {
rejected: (value) => `Unexpected disallowed value "${value}"`,
});
const {rule} = styleli... | 1,425 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/global-disallowed-list/index.test.js | const {ruleName} = require('.');
const config = [[/\$font-size-data/, /--p-token/]];
testRule({
ruleName,
plugins: [__dirname],
config,
customSyntax: 'postcss-scss',
accept: [
{
code: '.a { color: red; }',
description: 'Uses nothing on the disallowed list',
},
],
reject: [
{
... | 1,426 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/media-query-allowed-list/README.md | ## Media query allowed list plugin
The purpose of this plugin is to ensure we're following our established conventions for Polaris breakpoints, and only using breakpoints aliases generated from Polaris tokens.
### Enforced Rules
- Media queries must be defined using Polaris `breakpoints` aliases e.g. `@media #{$p-br... | 1,427 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/media-query-allowed-list/index.js | const stylelint = require('stylelint');
const mediaParser = require('postcss-media-query-parser').default;
const {
hasScssInterpolation,
scssInterpolationRegExp,
scssInterpolationExpression,
isString,
isRegExp,
matchesStringOrRegExp,
} = require('../../utils');
const ruleName = 'polaris/media-query-allowe... | 1,428 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris/plugins | petrpan-code/Shopify/polaris/stylelint-polaris/plugins/media-query-allowed-list/index.test.js | const {messages, ruleName} = require('.');
function matchNameRegExp(name) {
// Using `^` to match the start of a string since postcss normalizes name properties
// https://regex101.com/r/3tzvIW/1
return new RegExp(String.raw`^([\w-]+\.)?(?<![\w-])${name}(?![\w-])`);
}
// Allowed media types and media conditions... | 1,429 |
0 | petrpan-code/Shopify/polaris/stylelint-polaris | petrpan-code/Shopify/polaris/stylelint-polaris/utils/index.js | const scssInterpolationRegExp = /#\{.+?\}/;
/**
* Check whether a string has scss interpolation
* https://github.com/stylelint/stylelint/blob/main/lib/utils/hasScssInterpolation.js
*
* @param {string} string
*/
function hasScssInterpolation(string) {
return scssInterpolationRegExp.test(string);
}
/**
* Return... | 1,430 |
0 | petrpan-code/twentyhq | petrpan-code/twentyhq/twenty/.dockerignore | server/node_modules/
server/.env | 1,431 |
0 | petrpan-code/twentyhq | petrpan-code/twentyhq/twenty/LICENSE | GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
... | 1,432 |
0 | petrpan-code/twentyhq | petrpan-code/twentyhq/twenty/Makefile | %:
$(MAKE) -C infra/dev $*
| 1,433 |
0 | petrpan-code/twentyhq | petrpan-code/twentyhq/twenty/README.md |
<br>
<p align="center">
<a href="https://www.twenty.com">
<img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" />
</a>
</p>
<h2 align="center" >A Modern Open Source CRM </h3>
<p align="center">CRM flexibility, tailored to your unique business needs</p>
<p align="center">🌐 <a hre... | 1,434 |
0 | petrpan-code/twentyhq | petrpan-code/twentyhq/twenty/render.yaml | services:
- type: web
name: front
env: docker
dockerfilePath: ./infra/prod/front/Dockerfile
autoDeploy: false
envVars:
- key: REACT_APP_SERVER_BASE_URL
fromService:
name: server
type: web
envVarKey: RENDER_EXTERNAL_URL
- type: web
name: server
env: docker
dockerfilePath... | 1,435 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/.vscode/extensions.json | {
"recommendations": [
"ms-vscode-remote.remote-containers",
"styled-components.vscode-styled-components",
"dbaeumer.vscode-eslint",
"unifiedjs.vscode-mdx",
"ms-vscode.makefile-tools",
"esbenp.prettier-vscode",
"GraphQL.vscode-graphql",
"yoavbls.pretty-ts-errors",
"graphql.vscode-g... | 1,436 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/.vscode/settings.json | {
"editor.formatOnSave": false,
"files.eol": "auto",
"[typescript]": {
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.addMissingImports": "always"
}
},
"[javascript]": {
"editor.formatOnSave": false,
"editor.codeActionsOnSave":... | 1,437 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/.vscode/tasks.json | {
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "start",
"path": "server",
"problemMatcher": [],
"label": "yarn: start - server",
"detail": "yarn start"
}
]
} | 1,438 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/.vale.ini | StylesPath = ../.github/vale-styles
MinAlertLevel = suggestion
Packages = write-good
[*.{md,mdx}]
BasedOnStyles = Vale, write-good, docs
Vale.Spelling=warning
write-good.E-Prime=No
write-good.So=No
write-good.ThereIs=No
Vale.Terms=No
[formats]
mdx = md
| 1,439 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/README.md | # Documentation
The docs here are managed through [Docusaurus 2](https://docusaurus.io/).
We recommend you go directly to the [statically generated website](https://docs.twenty.com) rather than read them here. | 1,440 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/babel.config.js | module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
| 1,441 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/docusaurus.config.js |
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
import { themes } from 'prism-react-renderer';
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Twenty - Documentation",
taglin... | 1,442 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/package.json | {
"name": "docs",
"version": "0.1.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start --host 0.0.0.0 --port 5001",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "... | 1,443 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/sidebars.js | /**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
const backToHomeLink ... | 1,444 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/tsconfig.json | {
// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@docusaurus/tsconfig//tsconfig.json",
"compilerOptions": {
"baseUrl": "."
}
}
| 1,445 |
0 | petrpan-code/twentyhq/twenty | petrpan-code/twentyhq/twenty/docs/yarn.lock | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1
"@algolia/autocomplete-core@1.9.3":
version "1.9.3"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.9.3.tgz#1d56482a768c33aae0868c8533049e02e8961be7"
integrity sha512-009HdfugtGCdC4JdXUbVJ... | 1,446 |
0 | petrpan-code/twentyhq/twenty/docs | petrpan-code/twentyhq/twenty/docs/docs/index.mdx | ---
id: homepage
sidebar_position: 0
sidebar_class_name: display-none
title: Welcome
custom_edit_url: null
---
import ThemedImage from '@theme/ThemedImage';
import Footer from '@theme/Footer'
Twenty is an Open Source CRM that provides flexibility, tailored to your business needs. It helps you break free from vendor lo... | 1,447 |
0 | petrpan-code/twentyhq/twenty/docs/docs | petrpan-code/twentyhq/twenty/docs/docs/contributor/_category_.json | {
"label": "Contributor guide",
"position": 2
}
| 1,448 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/_category_.json | {
"position": 3
}
| 1,449 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/frontend.mdx | ---
id: frontend
title: Frontend Development
displayed_sidebar: frontendSidebar
sidebar_position: 0
sidebar_custom_props:
icon: TbTerminal2
isSidebarRoot: true
---
Welcome to the Frontend Development section of the documentation.
Here you will find information about the frontend development process, the recommend... | 1,450 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/advanced/_category_.json | {
"label": "Advanced",
"position": 3
}
| 1,451 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/advanced/best-practices.mdx | ---
title: Best Practices
sidebar_position: 3
sidebar_custom_props:
icon: TbChecklist
---
This document outlines the best practices you should follow when working on the frontend.
## State management
React and Recoil handle state management in the codebase.
### Use `useRecoilState` to store state
It's good pract... | 1,452 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/advanced/hotkeys.mdx | ---
title: Hotkeys
sidebar_position: 11
sidebar_custom_props:
icon: TbKeyboard
---
You can intercept any hotkey combination and execute a custom action.
There's a thin wrapper on top of [react-hotkeys-hook](https://react-hotkeys-hook.vercel.app/docs/intro) that makes it more performant and avoids unnecessary re-ren... | 1,453 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/advanced/style-guide.mdx | ---
title: Style Guide
sidebar_position: 4
sidebar_custom_props:
icon: TbPencil
---
This document includes the rules to follow when writing code.
The goal here is to have a consistent codebase, which is easy to read and easy to maintain.
For this, it's better to be a bit more verbose than to be too concise.
Alwa... | 1,454 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/_category_.json | {
"label": "Basics",
"position": 1
}
| 1,455 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/basics.mdx | ---
title: Basics
sidebar_position: 0
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
## Tech Stack
The project has a clean and simple stack, with minimal boilerplate code.
**App**
- [React](https://react.dev/)
- [Apollo](https://www.apollographql.com/docs/)
- [GraphQL Codegen](https://the-guild... | 1,456 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/contributing.mdx | ---
title: Contributing
sidebar_position: 1
description: Learn how you can contribute to the project
sidebar_custom_props:
icon: TbTopologyStar
---
## Pre-requisites
Make sure that your [IDE is correctly setup](/contributor/local-setup/ide-setup) and that your backend is running on `localhost:3000`.
## Starting a... | 1,457 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/design-system.mdx | ---
title: Design System
description: What our design system looks like
sidebar_position: 7
sidebar_custom_props:
icon: TbPaint
---
The CRM depends on its internal and custom design system, constructed on top of styled-components.
| 1,458 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/folder-architecture.mdx | ---
title: Folder Architecture
sidebar_position: 5
description: A detailed look into our folder architecture
sidebar_custom_props:
icon: TbFolder
---
In this guide, you will explore the details of the project directory structure and how it contributes to the organization and maintainability of Twenty.
By following ... | 1,459 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/basics/work-with-figma.mdx | ---
title: Work with Figma
description: Learn how you can collaborate with Twenty's Figma
sidebar_position: 2
sidebar_custom_props:
icon: TbBrandFigma
---
Figma is a collaborative interface design tool that aids in bridging the communication barrier between designers and developers.
This guide explains how you can c... | 1,460 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/_category_.json | {
"label": "UI Components",
"position": 1
}
| 1,461 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/ui-components.mdx | ---
title: UI Components
sidebar_position: 0
displayed_sidebar: uiDocsSidebar
sidebar_custom_props:
isSidebarRoot: true
icon: TbLayoutGrid
---
| 1,462 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/_category_.json | {
"label": "Display",
"position": 1,
"collapsible": true,
"collapsed": false,
"customProps": {
"icon": "TbAppWindow"
}
}
| 1,463 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/app-tooltip.mdx | ---
title: App Tooltip
sidebar_position: 6
sidebar_custom_props:
icon: TbTooltip
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import appTooltipCode from '!!raw-loader!@site/src/ui/display/appTooltipCode.js'
import overflowingTextWithTooltipCode from '!!raw-loader!@site/src/ui/display/ove... | 1,464 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/checkmark.mdx | ---
title: Checkmark
sidebar_position: 1
sidebar_custom_props:
icon: TbCheck
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import checkmarkCode from '!!raw-loader!@site/src/ui/display/checkmarkCode.js'
import animatedCheckmarkCode from '!!raw-loader!@site/src/ui/display/animatedCheckmarkC... | 1,465 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/chip.mdx | ---
title: Chip
sidebar_position: 2
sidebar_custom_props:
icon: TbLayoutList
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import chipCode from '!!raw-loader!@site/src/ui/display/chipCode.js'
import entityChipCode from '!!raw-loader!@site/src/ui/display/entityChipCode.js'
import { Sandpac... | 1,466 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/icons.mdx | ---
title: Icons
sidebar_position: 3
sidebar_custom_props:
icon: TbIcons
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import tablerIconExampleCode from '!!raw-loader!@site/src/ui/display/tablerIconExampleCode.js'
import iconAddressBookCode from '!!raw-loader!@site/src/ui/display/iconAddr... | 1,467 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/soon-pill.mdx | ---
title: Soon Pill
sidebar_position: 4
sidebar_custom_props:
icon: TbPill
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import soonPillCode from '!!raw-loader!@site/src/ui/display/soonPillCode.js'
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
A small badge or "pill" to in... | 1,468 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/display/tag.mdx | ---
title: Tag
sidebar_position: 5
sidebar_custom_props:
icon: TbTag
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import tagCode from '!!raw-loader!@site/src/ui/display/tagCode.js'
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
Component to visually categorize or label cont... | 1,469 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/feedback/_category_.json | {
"label": "Feedback",
"position": 2,
"collapsible": true,
"collapsed": false,
"customProps": {
"icon": "TbForms"
}
}
| 1,470 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/feedback/progress-bar.mdx | ---
title: Progress Bar
sidebar_position: 1
sidebar_custom_props:
icon: TbLoader2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import progressBarCode from '!!raw-loader!@site/src/ui/feedback/progressBarCode.js'
import circularProgressBarCode from '!!raw-loader!@site/src/ui/feedback/circu... | 1,471 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/_category_.json | {
"label": "Input",
"position": 3,
"collapsible": true,
"collapsed": false,
"customProps": {
"icon": "TbInputSearch"
}
}
| 1,472 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/button.mdx | ---
title: Buttons
sidebar_position: 1
sidebar_custom_props:
icon: TbSquareRoundedPlusFilled
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import buttonCode from '!!raw-loader!@site/src/ui/input/button/buttonCode.js'
import button... | 1,473 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/checkbox.mdx | ---
title: Checkbox
sidebar_position: 4
sidebar_custom_props:
icon: TbCheckbox
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import checkboxCode from '!!raw-loader!@site/src/ui/input/components/checkboxCode.js'
Used when a user... | 1,474 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/color-scheme.mdx | ---
title: Color Scheme
sidebar_position: 2
sidebar_custom_props:
icon: TbColorFilter
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import colorSchemeCardCode from '!!raw-loader!@site/src/ui/input/color-scheme/colorSchemeCardCode.js'
import colorSchemePickerCode from '!!raw-loader!@site/s... | 1,475 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/icon-picker.mdx | ---
title: Icon Picker
sidebar_position: 5
sidebar_custom_props:
icon: TbColorPicker
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import iconPickerCode from '!!raw-loader!@site/src/ui/input/components/iconPickerCode.js'
A dropd... | 1,476 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/image-input.mdx | ---
title: Image Input
sidebar_position: 6
sidebar_custom_props:
icon: TbUpload
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import imageInputCode from '!!raw-loader!@site/src/ui/input/components/imageInputCode.js'
Allows users... | 1,477 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/radio.mdx | ---
title: Radio
sidebar_position: 7
sidebar_custom_props:
icon: TbCircleDot
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import radioCode from '!!raw-loader!@site/src/ui/input/components/radioCode.js'
import radioGroupCode from... | 1,478 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components | petrpan-code/twentyhq/twenty/docs/docs/contributor/frontend/ui-components/input/text-input.mdx | ---
title: Text Inputs
sidebar_position: 3
sidebar_custom_props:
icon: TbTextSize
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { SandpackEditor} from '@site/src/ui/SandpackEditor'
import autoSizeTextInputCode from '!!raw-loader!@site/src/ui/input/components/autoSizeTextInputCode.j... | 1,479 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/_category_.json | {
"label": "Local setup",
"position": 1,
"collapsible": true,
"collapsed": true,
"customProps": {
"icon": "TbDeviceDesktop"
}
}
| 1,480 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/docker-setup.mdx | ---
title: Docker Setup
sidebar_position: 3
description: Set up the project with Docker
sidebar_custom_props:
icon: TbBrandDocker
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
This guide will walk you through provisioning the project with Docker. This comes with the following advantages:... | 1,481 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/ide-setup.mdx | ---
title: IDE Setup
sidebar_position: 4
description: Get the best developer UX with VSCode
sidebar_custom_props:
icon: TbBrandVscode
---
This section will help you set up your IDE for the project. If you haven't set up your development environment, please refer to the [local setup](/contributor/local-setup) section... | 1,482 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/local-setup.mdx | ---
title: Local Setup
sidebar_position: 0
sidebar_custom_props:
icon: TbDeviceDesktop
---
import ThemedImage from '@theme/ThemedImage';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import DocCardList from '@theme/DocCardList';
Twenty aims for developer-friendliness, and your local install... | 1,483 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/troubleshooting.mdx | ---
title: Troubleshooting
sidebar_position: 5
description: Common problems & their solutions.
sidebar_custom_props:
icon: TbExclamationCircle
---
## CR line breaks found [Windows]
This is due to the line break characters of Windows and the git configuration. Try running:
```
git config --global core.autocrlf fals... | 1,484 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/local-setup/yarn-setup.mdx | ---
title: Yarn Setup
sidebar_position: 1
description: |
Set up the project with Yarn
sidebar_custom_props:
icon: TbScript
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
In this document, you'll learn how to install the project using yarn. You should use this method since it's the easies... | 1,485 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/_category_.json | {
"position": 4
}
| 1,486 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/server.mdx | ---
title: Backend Development
displayed_sidebar: backendSidebar
sidebar_position: 0
sidebar_custom_props:
icon: TbTerminal
isSidebarRoot: true
---
Welcome to the Backend Development section of the documentation.
Here you will find information about the development process, the recommended tools, and the best pra... | 1,487 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/basics/_category_.json | {
"label": "Basics",
"position": 1
}
| 1,488 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/basics/custom-objects.mdx | ---
title: Custom Objects
sidebar_position: 4
sidebar_custom_props:
icon: TbAugmentedReality
---
Objects are structures that allow you to store data (records, attributes, and values) specific to an organization. Twenty provides both standard and custom objects.
Standard objects are in-built objects with a set of at... | 1,489 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/basics/folder-architecture.mdx | ---
title: Folder Architecture
sidebar_position: 2
description: A detailed look into our server folder architecture
sidebar_custom_props:
icon: TbFolder
---
The backend directory structure is as follows:
```
server
└───ability
└───constants
└───core
└───database
└───decorators
└───filters
└───guards... | 1,490 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/basics/overview.mdx | ---
title: Overview
sidebar_position: 0
sidebar_custom_props:
icon: TbEyeglass
---
Twenty primarily uses NestJS for the backend.
Prisma was the first choice as the ORM with a lot of auto-generated code under the hood. But to offer users flexibility and allow them to create custom fields and custom objects, somethi... | 1,491 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/basics/workflows.mdx | ---
title: Development workflow
sidebar_position: 3
sidebar_custom_props:
icon: TbTopologyStar
---
## First time setup
```
cd server
yarn # install dependencies
yarn prisma:migrate # run migrations
yarn prisma:generate # generate prisma and nestjs-graphql schemas
yarn prisma:seed # provision database with seeds
#... | 1,492 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/others/_category_.json | {
"label": "Others",
"position": 2
}
| 1,493 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/others/best-practices.mdx | ---
title: Best Practices
sidebar_position: 3
sidebar_custom_props:
icon: TbChecklist
---
This document outlines the best practices you should follow when working on the backend.
## Follow a modular approach
The backend follows a modular approach, which is a fundamental principle when working with NestJS. Make sur... | 1,494 |
0 | petrpan-code/twentyhq/twenty/docs/docs/contributor/server | petrpan-code/twentyhq/twenty/docs/docs/contributor/server/others/zapier.mdx | ---
title: Zapier App
sidebar_position: 1
sidebar_custom_props:
icon: TbBrandZapier
---
Effortlessly sync Twenty with 3000+ apps using [Zapier](https://zapier.com/). Automate tasks, boost productivity, and supercharge your customer relationships!
## About Zapier
Zapier is a tool that allows you automate workflows ... | 1,495 |
0 | petrpan-code/twentyhq/twenty/docs/docs | petrpan-code/twentyhq/twenty/docs/docs/developer/_category_.json | {
"label": "Developer guide",
"position": 3
}
| 1,496 |
0 | petrpan-code/twentyhq/twenty/docs/docs | petrpan-code/twentyhq/twenty/docs/docs/developer/graphql_api.mdx | ---
title: GraphQL API
sidebar_position: 2
sidebar_custom_props:
icon: TbBrandGraphql
---
Use the [in-browser GraphiQL app](https://docs.twenty.com/graphql/) to browse, query, and mutate the introspection query.
## What is GraphQL?
GraphQL is a query language for APIs that enables declarative data fetching that a... | 1,497 |
0 | petrpan-code/twentyhq/twenty/docs/docs | petrpan-code/twentyhq/twenty/docs/docs/developer/rest_api.mdx | ---
title: Rest API
sidebar_position: 3
sidebar_class_name: coming-soon
sidebar_custom_props:
icon: TbApi
---
Coming soon! | 1,498 |
0 | petrpan-code/twentyhq/twenty/docs/docs | petrpan-code/twentyhq/twenty/docs/docs/start/_category_.json | {
"label": "Start",
"position": 1
}
| 1,499 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.