2525
2626## 1. Clone the Repository
2727
28- ``` sh
28+ ``` shell
2929git clone git@github.com:scify/annotation-management-system.git
3030
3131cd annotation-management-system
@@ -37,7 +37,7 @@ The pre-commit hook scans staged files for secrets (API keys, passwords, tokens)
3737
3838Download the binary for your platform:
3939
40- ``` sh
40+ ``` shell
4141# Linux (x64)
4242curl -sSL https://github.com/gitleaks/gitleaks/releases/download/v8.28.0/gitleaks_8.28.0_linux_x64.tar.gz | tar -xz gitleaks
4343
@@ -50,7 +50,7 @@ curl -sSL https://github.com/gitleaks/gitleaks/releases/download/v8.28.0/gitleak
5050
5151Make it executable and verify:
5252
53- ``` sh
53+ ``` shell
5454chmod +x gitleaks
5555./gitleaks version
5656```
@@ -68,7 +68,7 @@ environment variable.
6868The default ` .env ` file contains the general configuration, and is used by both ** DDEV** and ** Native** .
6969Copy the ` .env.example ` file to create a new ` .env ` file, and edit as needed:
7070
71- ``` sh
71+ ``` shell
7272cp .env.example .env
7373
7474# then edit the APP_DEVELOPMENT_ENV variable to either 'ddev' or 'native'
@@ -92,7 +92,7 @@ VITE_DEV_PORT = "5179"
9292
9393You can copy the ` .env.ddev.example ` file to create a new ` .env.ddev ` file:
9494
95- ``` sh
95+ ``` shell
9696cp .env.ddev.example .env.ddev
9797```
9898
@@ -115,7 +115,7 @@ VITE_DEV_PORT = "5173"
115115
116116You can copy the ` .env.native.example ` file to create a new ` .env.native ` file:
117117
118- ``` sh
118+ ``` shell
119119cp .env.native.example .env.native
120120```
121121
@@ -125,7 +125,7 @@ If you want to switch between **DDEV** and **Native** for development, you can s
125125environment variable to either ` ddev ` or ` native ` .
126126** Note:** After switching environments, you will need to clear the config cache (both DDEV and Native):
127127
128- ``` sh
128+ ``` shell
129129ddev restart # If using DDEV
130130
131131./clear-cache.sh
@@ -135,51 +135,63 @@ ddev restart # If using DDEV
135135
136136First generate an application key:
137137
138- ``` sh
138+ ``` shell
139139ddev artisan key:generate
140140```
141141
142142To start the development environment using ** DDEV** :
143143
144- ``` sh
144+ ``` shell
145145ddev start
146146```
147147
148148Run migrations:
149149
150- ``` sh
150+ ``` shell
151151ddev artisan migrate
152152```
153153
154+ Run the database seeder:
155+
156+ ``` shell
157+ ddev artisan db:seed
158+ ```
159+
154160Start the frontend development server:
155161
156- ``` sh
162+ ``` shell
157163ddev npm run dev
158164```
159165
160166### 4.2 Using Native
161167
162168First generate an application key:
163169
164- ``` sh
170+ ``` shell
165171php artisan key:generate
166172```
167173
168174To switch back to using Native for local development:
169175
170- ``` sh
176+ ``` shell
171177composer install
172178```
173179
174180Run migrations:
175181
176- ``` sh
182+ ``` shell
177183php artisan migrate
178184```
179185
186+ Run the database seeder:
187+
188+ ``` shell
189+ php artisan db:seed
190+ ```
191+
180192Start the frontend development server:
181193
182- ``` sh
194+ ``` shell
183195npm run dev
184196```
185197
@@ -209,7 +221,6 @@ Use tools like [ncu](https://www.npmjs.com/package/npm-check-updates) to check f
209221
210222## 7. Where to Go From Here
211223
212- - Watch [ this video] ( https://www.youtube.com/watch?v=phaBzRIioAw ) to learn more about the Vue/Inertia setup.
213224- Take a look at ` app/Providers/AppServiceProvider.php ` to check the configuration.
214225
215226## 8. Troubleshooting
0 commit comments