mirror of
https://github.com/lingble/twenty.git
synced 2025-11-02 13:47:55 +00:00
Update doc & split prisma generate (#299)
* feat: split prisma generate * fix: update doc
This commit is contained in:
@@ -33,6 +33,8 @@ You can run `docker-compose --version` and `docker --version` to check they are
|
|||||||
### 3. Setup env variables
|
### 3. Setup env variables
|
||||||
|
|
||||||
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
||||||
|
`cp ./front/.env.example ./front/.env` and fill with values
|
||||||
|
`cp ./server/.env.example ./server/.env` and fill with values
|
||||||
|
|
||||||
### 4. Build
|
### 4. Build
|
||||||
|
|
||||||
@@ -51,21 +53,52 @@ make build
|
|||||||
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
||||||
We will add an easier option soon.
|
We will add an easier option soon.
|
||||||
|
|
||||||
### 6. Start
|
### 6. Migrate & seed
|
||||||
|
|
||||||
Always in the `infra/dev` folder:
|
Before running the project, we need to apply database init and migrations and run the seed.
|
||||||
|
|
||||||
|
Always in the `infra/dev` folder.
|
||||||
|
|
||||||
|
Run the containers:
|
||||||
```
|
```
|
||||||
make up
|
make up
|
||||||
```
|
```
|
||||||
|
|
||||||
Once this is completed you should have:
|
Generate database init and migrations:
|
||||||
|
```
|
||||||
|
make server-prisma-migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
Generate prisma client
|
||||||
|
```
|
||||||
|
make server-prisma-generate-client
|
||||||
|
```
|
||||||
|
|
||||||
|
Seed the database:
|
||||||
|
```
|
||||||
|
make server-prisma-seed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7. Start
|
||||||
|
|
||||||
|
Once this is completed you can run the project with the following commands:
|
||||||
|
|
||||||
|
front:
|
||||||
|
```
|
||||||
|
make front-start
|
||||||
|
```
|
||||||
|
|
||||||
|
server:
|
||||||
|
```
|
||||||
|
make-server start
|
||||||
|
```
|
||||||
|
|
||||||
- front available on: http://localhost:3001
|
- front available on: http://localhost:3001
|
||||||
- server available on: http://localhost:3000/health
|
- server available on: http://localhost:3000/healthz
|
||||||
- postgres: available on http://localhost:5432 that should contain `twenty` database
|
- postgres: available on http://localhost:5432 that should contain `twenty` database
|
||||||
|
|
||||||
|
|
||||||
### 6. Development
|
### 8. Development
|
||||||
|
|
||||||
Documented [here](../development/workflows.mdx)
|
Documented [here](../development/workflows.mdx)
|
||||||
|
|
||||||
|
|||||||
@@ -29,8 +29,11 @@ front-storybook:
|
|||||||
server-start:
|
server-start:
|
||||||
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn start:dev"
|
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn start:dev"
|
||||||
|
|
||||||
server-prisma-generate:
|
server-prisma-generate-client:
|
||||||
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn prisma:generate"
|
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn prisma:generate-client"
|
||||||
|
|
||||||
|
server-prisma-generate-nest-graphql:
|
||||||
|
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn prisma:generate-nest-graphql"
|
||||||
|
|
||||||
server-prisma-migrate:
|
server-prisma-migrate:
|
||||||
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn prisma:migrate"
|
@docker-compose exec twenty-dev sh -c "cd /app/server && yarn prisma:migrate"
|
||||||
|
|||||||
@@ -19,10 +19,11 @@
|
|||||||
"test:cov": "jest --coverage",
|
"test:cov": "jest --coverage",
|
||||||
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
|
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
|
||||||
"test:e2e": "jest --config ./test/jest-e2e.json",
|
"test:e2e": "jest --config ./test/jest-e2e.json",
|
||||||
"prisma:generate": "npx prisma generate && eslint \"src/api/@generated/**\" --fix",
|
"prisma:generate-client": "npx prisma generate --generator client",
|
||||||
|
"prisma:generate-nest-graphql": "npx prisma generate --generator nestgraphql && eslint \"src/api/@generated/**\" --fix",
|
||||||
"prisma:migrate": "npx prisma migrate deploy",
|
"prisma:migrate": "npx prisma migrate deploy",
|
||||||
"prisma:seed": "npx prisma db seed",
|
"prisma:seed": "npx prisma db seed",
|
||||||
"prisma:reset": "npm run prisma:generate && npx prisma migrate reset"
|
"prisma:reset": "yarn prisma:generate-client && yarn prisma:generate-nest-grapql && npx prisma migrate reset"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@apollo/server": "^4.7.3",
|
"@apollo/server": "^4.7.3",
|
||||||
|
|||||||
Reference in New Issue
Block a user