2023-02-19 10:06:52 +01:00
|
|
|
# Ghostfolio Development Guide
|
|
|
|
|
|
2023-10-21 10:25:05 +02:00
|
|
|
## Experimental Features
|
|
|
|
|
|
|
|
|
|
New functionality can be enabled using a feature flag switch from the user settings.
|
|
|
|
|
|
|
|
|
|
### Backend
|
|
|
|
|
|
|
|
|
|
Remove permission in `UserService` using `without()`
|
|
|
|
|
|
|
|
|
|
### Frontend
|
|
|
|
|
|
|
|
|
|
Use `*ngIf="user?.settings?.isExperimentalFeatures"` in HTML template
|
|
|
|
|
|
2023-02-19 10:06:52 +01:00
|
|
|
## Git
|
|
|
|
|
|
|
|
|
|
### Rebase
|
|
|
|
|
|
|
|
|
|
`git rebase -i --autosquash main`
|
|
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
### Nx
|
|
|
|
|
|
|
|
|
|
#### Upgrade
|
|
|
|
|
|
|
|
|
|
1. Run `yarn nx migrate latest`
|
|
|
|
|
1. Make sure `package.json` changes make sense and then run `yarn install`
|
|
|
|
|
1. Run `yarn nx migrate --run-migrations`
|
|
|
|
|
|
|
|
|
|
### Prisma
|
|
|
|
|
|
2023-10-04 08:48:50 +02:00
|
|
|
#### Access database via GUI
|
|
|
|
|
|
|
|
|
|
Run `yarn database:gui`
|
|
|
|
|
|
|
|
|
|
https://www.prisma.io/studio
|
|
|
|
|
|
2023-04-23 11:02:12 +02:00
|
|
|
#### Synchronize schema with database for prototyping
|
|
|
|
|
|
|
|
|
|
Run `yarn database:push`
|
|
|
|
|
|
|
|
|
|
https://www.prisma.io/docs/concepts/components/prisma-migrate/db-push
|
|
|
|
|
|
|
|
|
|
#### Create schema migration
|
2023-02-19 10:06:52 +01:00
|
|
|
|
|
|
|
|
Run `yarn prisma migrate dev --name added_job_title`
|
|
|
|
|
|
|
|
|
|
https://www.prisma.io/docs/concepts/components/prisma-migrate#getting-started-with-prisma-migrate
|
