File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -96,6 +96,25 @@ deno task test:cov # Get test coverage by running tests that hit "localhost"
9696deno task test:ci # Run tests that hit "https://serpapi.com"
9797```
9898
99+ ## Run examples on local source files
100+
101+ To run [ examples] ( ./examples/ ) on your local source files, follow these steps.
102+
103+ 1 . Run ` deno task npm ` to build the files.
104+ 2 . Update the respective example's ` package.json ` to depend on the local
105+ ` serpapi ` module instead,
106+ ``` json
107+ {
108+ "dependencies" : {
109+ "dotenv" : " *" ,
110+ "serpapi" : " ../../../npm"
111+ },
112+ "scripts" : {
113+ "start" : " node example.js"
114+ }
115+ }
116+ ```
117+
99118## Update documentation
100119
101120- Every exposed function must have associated JSDoc comments.
@@ -112,7 +131,8 @@ deno task docs:gen
112131TypeScript types are generated from the backend code. Follow these steps to
113132update the types.
114133
115- 1 . Run ` bundle exec rails sdk:generate_ts_types ` in the backend repository.
134+ 1 . Run ` bundle exec rails libraries:generate_ts_types ` in the backend
135+ repository.
1161362 . Replace everything in ` src/engines ` with the generated files from
117137 ` tmp/ts/engines ` .
1181383 . Update ` mod.ts ` with the new engine exports from ` tmp/ts/mod.ts ` .
You can’t perform that action at this time.
0 commit comments