You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development_guide.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,6 +120,12 @@ Access to fetch at 'http://localhost:3001/v1/torrents?page_size=50&page=0&sort=U
120
120
121
121
You need to enable the Cors layer with the permissive option setting the environment variable `TORRUST_INDEX_API_CORS_PERMISSIVE` to `true`.
122
122
123
+
For example:
124
+
125
+
```console
126
+
TORRUST_INDEX_API_CORS_PERMISSIVE=true cargo run
127
+
```
128
+
123
129
## Run the Index GUI
124
130
125
131
Requirements:
@@ -170,6 +176,47 @@ npm run build && npm run preview
170
176
171
177
More information about the [nuxt][nuxt] command can be found [here][nuxt_commands].
172
178
179
+
### Working with Torrust Dependencies
180
+
181
+
We have two internal dependencies:
182
+
183
+
-[torrust-index-types-lib](https://github.com/torrust/torrust-index-types-lib): Basic TypeScript types for the Index API.
184
+
-[torrust-index-api-lib](https://github.com/torrust/torrust-index-api-lib): A wrapper in TypeScript for the INdex API.
185
+
186
+
Sometimes when the Index API changes, it might be useful to test the Index GUI with the new packages versions at the same time before releasing new versions for these packages. You could even be working on the Index API, the Index GUI and these packages at the same time if the feature requires changes in the API.
187
+
188
+
There are two ways of using local packages with NPM:
And your `node_modules` should have symbolic links for these packages.
215
+
216
+
You can start changing any project. You will need to rebuild the dependency (`npm run build`) any time you make a change. If you are using `npm run dev` for the Index GUI you won't need to do anything else.
217
+
218
+
> Warning: You can't push these changes in the `package.json`. Once you are done you have to release a new package version and update the `package.json`.
0 commit comments