44baaee28e
* Update scripts and documentation to use nx and new monorepo architecture * Start fixing docker * Migrate eslint plugin and postgres setup * Fix docker * Fix patches * Fix * fix: wip try to fix the patches * Apply patches --------- Co-authored-by: Jérémy Magrin <jeremy.magrin@gmail.com>
49 lines
1.7 KiB
Plaintext
49 lines
1.7 KiB
Plaintext
---
|
|
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 installation should be up and running in just a bit.
|
|
|
|
<DocCardList/>
|
|
|
|
## Discord
|
|
|
|
If you have any questions or need help, you can join Twenty's [Discord](https://twenty.com/discord) server.
|
|
|
|
## MacOS and Linux users
|
|
|
|
It's better to use [yarn installation](/contributor/local-setup/yarn-setup) as this is the easiest way to get started.
|
|
But there's also an easy way to run the project with [Docker](/contributor/local-setup/docker-setup) that you can use if you are familiar with containerized environments.
|
|
|
|
## Windows users
|
|
|
|
Windows users can install the project through WSL2. [This guide](/contributor/local-setup/yarn-setup) can help you get started.
|
|
|
|
## Project structure
|
|
|
|
The repository has the following structure:
|
|
```
|
|
twenty
|
|
└───packages // contains this documentation
|
|
└───twenty-front // contains the frontend code for the application
|
|
└───twenty-server // contains the backend code for the application
|
|
└───twenty-docker // contains docker configurations for development and production build
|
|
└───many other packages your are invited to discover such as twenty-docs, twenty-ui, twenty-eslint-plugin, twenty-zapier...
|
|
```
|
|
|
|
## IDE Setup
|
|
|
|
Once Twenty is running on your computer, you will get the best experience by using an IDE that supports TypeScript and ESLint.
|
|
You will find a guide for [VSCode](/contributor/local-setup/ide-setup) further in the documentation.
|
|
___
|
|
|