mirror of
https://github.com/twentyhq/twenty.git
synced 2024-12-23 12:02:10 +03:00
Update install instruction in docs (#376)
This commit is contained in:
parent
9c21975d2b
commit
3c5a270eca
@ -2,6 +2,5 @@
|
|||||||
|
|
||||||
DEBIAN_FRONTEND=noninteractive
|
DEBIAN_FRONTEND=noninteractive
|
||||||
|
|
||||||
cd infra/dev
|
|
||||||
make build
|
make build
|
||||||
make up
|
make up
|
@ -39,18 +39,12 @@ This install will also provision a Postgres container.
|
|||||||
The configuration is stored `infra/dev` folder.
|
The configuration is stored `infra/dev` folder.
|
||||||
|
|
||||||
```
|
```
|
||||||
cd infra/dev
|
|
||||||
make build
|
make build
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5. Auth setup
|
### 5. Migrate & seed
|
||||||
|
|
||||||
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
Before running the project, we need to init the database by running migration and seeds.
|
||||||
We will add an easier option soon.
|
|
||||||
|
|
||||||
### 6. Migrate & seed
|
|
||||||
|
|
||||||
Before running the project, we need to apply database init and migrations and run the seed.
|
|
||||||
|
|
||||||
Always go the `infra/dev` folder to run the `make` commands.
|
Always go the `infra/dev` folder to run the `make` commands.
|
||||||
|
|
||||||
@ -59,22 +53,26 @@ Start the containers:
|
|||||||
make up
|
make up
|
||||||
```
|
```
|
||||||
|
|
||||||
Run database migrations:
|
Run database migrations, generate prisma client and seed:
|
||||||
```
|
```
|
||||||
make server-prisma-migrate
|
make server-prisma-migrate
|
||||||
```
|
|
||||||
|
|
||||||
Generate prisma client
|
|
||||||
```
|
|
||||||
make server-prisma-generate-client
|
make server-prisma-generate-client
|
||||||
```
|
|
||||||
|
|
||||||
Seed the database:
|
|
||||||
```
|
|
||||||
make server-prisma-seed
|
make server-prisma-seed
|
||||||
```
|
```
|
||||||
|
|
||||||
### 7. Start
|
You can also ssh directly in the container and run these commands from the container:
|
||||||
|
```
|
||||||
|
make sh
|
||||||
|
```
|
||||||
|
Then
|
||||||
|
```
|
||||||
|
cd server
|
||||||
|
yarn prisma:migrate
|
||||||
|
yarn prisma:generate-client
|
||||||
|
yarn prisma:seed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6. Start
|
||||||
|
|
||||||
Once this is completed you can run the project with the following commands:
|
Once this is completed you can run the project with the following commands:
|
||||||
|
|
||||||
@ -85,7 +83,7 @@ make front-start
|
|||||||
|
|
||||||
server:
|
server:
|
||||||
```
|
```
|
||||||
make-server start
|
make server-start
|
||||||
```
|
```
|
||||||
|
|
||||||
- front available on: http://localhost:3001
|
- front available on: http://localhost:3001
|
||||||
@ -93,10 +91,6 @@ make-server start
|
|||||||
- postgres: available on http://localhost:5432 and should contain database named `twenty`
|
- postgres: available on http://localhost:5432 and should contain database named `twenty`
|
||||||
|
|
||||||
|
|
||||||
### 8. Development
|
|
||||||
|
|
||||||
Documented [here](../dev/workflows.mdx)
|
|
||||||
|
|
||||||
## Without Docker
|
## Without Docker
|
||||||
|
|
||||||
While Docker is the recommended way to run Twenty, you might want to run the project directly on your machine.
|
While Docker is the recommended way to run Twenty, you might want to run the project directly on your machine.
|
||||||
@ -119,7 +113,7 @@ cp ./server/.env.example ./server/.env
|
|||||||
|
|
||||||
Most default value should work out of the box, but don't forget to update the database connection string.
|
Most default value should work out of the box, but don't forget to update the database connection string.
|
||||||
|
|
||||||
### 4. Build
|
### 4. Build, Migrate & Seed
|
||||||
On the frontend:
|
On the frontend:
|
||||||
```
|
```
|
||||||
cd front
|
cd front
|
||||||
@ -131,14 +125,11 @@ On the server side:
|
|||||||
cd server
|
cd server
|
||||||
yarn
|
yarn
|
||||||
yarn prisma:migrate
|
yarn prisma:migrate
|
||||||
|
yarn prisma:generate-client
|
||||||
|
yarn prisma:seed
|
||||||
```
|
```
|
||||||
You can also run `yarn prisma:seed` to seed the database with mock data.
|
|
||||||
|
|
||||||
### 5. Auth Setup
|
### 5. Start
|
||||||
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
|
||||||
We will add an easier option soon.
|
|
||||||
|
|
||||||
### 6. Start
|
|
||||||
On the frontend:
|
On the frontend:
|
||||||
```
|
```
|
||||||
cd front
|
cd front
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "docs",
|
"name": "docs",
|
||||||
"version": "0.0.0",
|
"version": "0.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"docusaurus": "docusaurus",
|
"docusaurus": "docusaurus",
|
||||||
|
Loading…
Reference in New Issue
Block a user