admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: lint readme

Browse Source
This commit is contained in:
Sammy Teillet
2023-04-18 15:37:05 +02:00
parent 77c387e14a
commit 24a3a9d828
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -5,6 +5,7 @@ Welcome to Twenty documentation!
## High Level Overview ## High Level Overview
Twenty development stack is composed of 3 different layers Twenty development stack is composed of 3 different layers
- front: our frontend React app - front: our frontend React app
- hasura: our graphql engine exposing our database and server - hasura: our graphql engine exposing our database and server
- server: our backend that contain endpoint, crm logic, scripts, jobs... - server: our backend that contain endpoint, crm logic, scripts, jobs...
@ -20,12 +21,15 @@ Twenty development stack is composed of 3 different layers
We also provide a containerized environment with Docker and orchestrated with docker-compose in case it is easier for you. This install will also provision a postgres container out of the box. We also provide a containerized environment with Docker and orchestrated with docker-compose in case it is easier for you. This install will also provision a postgres container out of the box.
### Step 1: pre-requesites ### Step 1: pre-requesites
Make sure to have the latest Docker and Docker-compose versions installed on your computer. You can run `docker-compose --version` to check if you have docker-compose installed and `docker --version` to check if you have docker installed. Make sure to have the latest Docker and Docker-compose versions installed on your computer. You can run `docker-compose --version` to check if you have docker-compose installed and `docker --version` to check if you have docker installed.
### Step 2: docker build ### Step 2: docker build
Build docker containers. Build docker containers.
The whole setup experience is happening in `infra/dev` folder. Make sure to be in this folder: The whole setup experience is happening in `infra/dev` folder. Make sure to be in this folder:
``` ```
cd infra/dev cd infra/dev
``` ```
@ -35,6 +39,7 @@ make build
``` ```
Once this is completed you should have: Once this is completed you should have:
- front available on: http://localhost:3001 - front available on: http://localhost:3001
- hasura available on: http://localhost:8080 - hasura available on: http://localhost:8080
- server available on: http://localhost:3000/health - server available on: http://localhost:3000/health