{"id":24972978,"url":"https://github.com/weaviate-tutorials/quickstart-typescript","last_synced_at":"2025-07-17T16:37:51.597Z","repository":{"id":251224492,"uuid":"836766731","full_name":"weaviate-tutorials/quickstart-typescript","owner":"weaviate-tutorials","description":"Working typescript example of the Weaviate quickstart","archived":false,"fork":false,"pushed_at":"2024-09-11T15:53:17.000Z","size":35,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-03T18:11:21.047Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/weaviate-tutorials.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-01T14:10:13.000Z","updated_at":"2024-09-11T15:53:21.000Z","dependencies_parsed_at":"2024-09-11T22:22:02.644Z","dependency_job_id":"d80741ad-3d56-4a4f-916e-8a1bff3c8fc2","html_url":"https://github.com/weaviate-tutorials/quickstart-typescript","commit_stats":null,"previous_names":["weaviate-tutorials/quickstart-typescript"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate-tutorials%2Fquickstart-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate-tutorials%2Fquickstart-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate-tutorials%2Fquickstart-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate-tutorials%2Fquickstart-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/weaviate-tutorials","download_url":"https://codeload.github.com/weaviate-tutorials/quickstart-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246145079,"owners_count":20730495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-03T18:11:02.070Z","updated_at":"2025-03-29T06:11:02.414Z","avatar_url":"https://github.com/weaviate-tutorials.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Weaviate quickstart code - TypeScript\n\nThis repo contains TypeScript code to follow along with the Weaviate\n[Quickstart](https://weaviate.io/developers/weaviate/quickstart). The code\ncorresponds to the Quickstart as of 2024-07-31.\n\n## Run the project\n\nThere are two code files. Both files use the [TypeScript v3 client](https://weaviate.io/developers/weaviate/client-libraries/typescript/typescript-v3).\n\n- `quickstart-setup.ts` This code creates a collection.\n- `quickstart-query.ts` This code queries the collection.\n\nTo run the project, follow these steps:\n\n1. Clone the repository.\n1. Install all relevant dependencies with `npm run install`. \n1. Configure [environment variables](#configure-environment-variables) to connect to a Weaviate instance.\n1. Use `quickstart-setup.ts` to create the example collection by running `npm run setup` in your terminal\n1. To make a query, edit `quickstart-query.ts` and uncomment the line that calls the\nquery then run `npm run query` in your terminal.\n\n## Configure environment variables\n\nThe client connection uses these environment variables:\n\n| Variable | Meaning |\n| :- | :- |\n| WCD_URL | The URL for your Weaviate instance |\n| WCD_API_KEY | The authentication API key for your Weaviate instance |\n| OPENAI_API_KEY | The authentication API key for your OpenAI account |\n\nIf you are using a Weaviate Cloud instance to run the Quickstart, the instance\nURL and API key are listed in the cluster details\n[panel](https://weaviate.io/developers/wcs/connect#retrieve-your-api-keys).\n\nIf you don't have an OpenAI key, [register at OpenAI](https://platform.openai.com/signup)\nto get one.\n\nFor more information, see [Environment variables](https://weaviate.io/developers/weaviate/connections/connect-cloud#environment-variables)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweaviate-tutorials%2Fquickstart-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweaviate-tutorials%2Fquickstart-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweaviate-tutorials%2Fquickstart-typescript/lists"}