diff --git a/docs/docs/dev/glossary.mdx b/docs/docs/dev/glossary.mdx index c72c8eca5..6c01aabab 100644 --- a/docs/docs/dev/glossary.mdx +++ b/docs/docs/dev/glossary.mdx @@ -5,15 +5,15 @@ sidebar_custom_props: # Glossary ### Workspace -A workspace usually represents a company using Twenty. +A `Workspace` usually represents a company using Twenty. It's attached to a single domain name, which is usually the domain name you company uses for your employee email addresses. ### Company & People -They are the two fundamental type of records that the CRM is built around. -A company represents a business or an organization. And People represents an individual you are doing business with or would like to do business with. +They are the two fundamental types of records that the CRM is built around. +A `Company` represents a business or an organization. `People` represents an individual you are doing business with or would like to do business with. ### Pipelines -A pipeline is a way to track a business process. -Pipelines are categorized within a module and have stages. -A module is the business characterizations of your process (e.g. sales, recruiting). -Stages maps the steps in your process (e.g. new, ongoing, won, lost) +A `Pipeline` is a way to track a business process. +`Pipeline`s are categorized within a module and have stages: +- A module is the business characterizations of your process (e.g. sales, recruiting). +- Stages maps the steps in your process (e.g. new, ongoing, won, lost) diff --git a/docs/docs/dev/workflows.mdx b/docs/docs/dev/workflows.mdx index 352dfc415..be9596e61 100644 --- a/docs/docs/dev/workflows.mdx +++ b/docs/docs/dev/workflows.mdx @@ -13,9 +13,7 @@ This will allow you to run Visual Studio on top of the docker container. ## Front tests -Run tests: `make front-test` -Run coverage: `make front-coverage` -Run storybook: `make front-storybook` +Run tests: `make front-test` ## Running commands If you are using Docker install, make sure to ssh in the docker container during development to execute commands. diff --git a/docs/docs/start/local-setup.mdx b/docs/docs/start/local-setup.mdx index 0b7e2a72f..b44d5ee58 100644 --- a/docs/docs/start/local-setup.mdx +++ b/docs/docs/start/local-setup.mdx @@ -21,6 +21,15 @@ You can run `docker-compose --version` and `docker --version` to check they are git clone git@github.com:twentyhq/twenty.git ``` +The repository is structured as follows: +``` +twenty +└───docs // contains this documentation +└───front // contains the frontend code for the application +└───server // contains the backend code for the application +└───infra // contains the deployment configurations for dev and prod +``` + ### 3. Setup env variables Go to the cloned folder (`cd twenty`). Then copy the env files: @@ -86,6 +95,11 @@ server: make server-start ``` +(optional) [storybook](https://storybook.js.org/): +``` +make front-storybook +``` + - front available on: http://localhost:3001 - server available on: http://localhost:3000/healthz - postgres: available on http://localhost:5432 and should contain database named `twenty`