diff --git a/README.md b/README.md index 4b6e5248..d52d93ec 100755 --- a/README.md +++ b/README.md @@ -125,6 +125,42 @@ Consider checking out the commands listed in /app/Makefile. > Please only use them if you know what you are doing! +### Generating mock data + +Generate mock users, opportunities, applications and reviews using **faker** scripts. + +How to generate mock data: + +1. **Run local DB** + + ```bash + docker-compose up + ``` + +2. **Login via Slack Authentication** + + - Open the UI and log in via Slack authentication. This will create a session and a User entry in the DB. + +3. **Seed local DB** + + - Run the following command to seed the local DB with mock data: + + ```bash + bun db:seed + ``` + +Command Line Options: + +```bash +~ bun db:seed -h +``` + +Reset/Clear DB: + +```bash +~ bun prisma migrate reset +``` + ### Working on a Linear ticket Working with Linear tickets is very similar to working with GitHub issues.