Fix typo, add file tree (#475)

This commit is contained in:
Emilien Chauvet
2023-06-29 11:36:40 -07:00
committed by GitHub
parent 695ddd7a92
commit fdfcae6ac5
3 changed files with 22 additions and 10 deletions

View File

@ -5,15 +5,15 @@ sidebar_custom_props:
# Glossary # Glossary
### Workspace ### 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. It's attached to a single domain name, which is usually the domain name you company uses for your employee email addresses.
### Company & People ### Company & People
They are the two fundamental type of records that the CRM is built around. They are the two fundamental types 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. 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 ### Pipelines
A pipeline is a way to track a business process. A `Pipeline` is a way to track a business process.
Pipelines are categorized within a module and have stages. `Pipeline`s are categorized within a module and have stages:
A module is the business characterizations of your process (e.g. sales, recruiting). - 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) - Stages maps the steps in your process (e.g. new, ongoing, won, lost)

View File

@ -14,8 +14,6 @@ This will allow you to run Visual Studio on top of the docker container.
## Front tests ## Front tests
Run tests: `make front-test` Run tests: `make front-test`
Run coverage: `make front-coverage`
Run storybook: `make front-storybook`
## Running commands ## Running commands
If you are using Docker install, make sure to ssh in the docker container during development to execute commands. If you are using Docker install, make sure to ssh in the docker container during development to execute commands.

View File

@ -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 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 ### 3. Setup env variables
Go to the cloned folder (`cd twenty`). Then copy the env files: Go to the cloned folder (`cd twenty`). Then copy the env files:
@ -86,6 +95,11 @@ server:
make server-start make server-start
``` ```
(optional) [storybook](https://storybook.js.org/):
```
make front-storybook
```
- front available on: http://localhost:3001 - front available on: http://localhost:3001
- server available on: http://localhost:3000/healthz - server available on: http://localhost:3000/healthz
- postgres: available on http://localhost:5432 and should contain database named `twenty` - postgres: available on http://localhost:5432 and should contain database named `twenty`