https://github.com/basemax/googleclonegraphqlts
This is a search engine site built using TypeScript and NestJS, with a GraphQL API. The application allows users to search for content and retrieve relevant results. It utilizes the power of GraphQL for efficient querying and retrieving data from various sources.
https://github.com/basemax/googleclonegraphqlts
graphql graphql-ts graphql-typescript javascript js ts typescript typescript-graphql
Last synced: about 2 months ago
JSON representation
This is a search engine site built using TypeScript and NestJS, with a GraphQL API. The application allows users to search for content and retrieve relevant results. It utilizes the power of GraphQL for efficient querying and retrieving data from various sources.
- Host: GitHub
- URL: https://github.com/basemax/googleclonegraphqlts
- Owner: BaseMax
- License: gpl-3.0
- Created: 2023-07-10T12:37:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T22:56:10.000Z (2 months ago)
- Last Synced: 2025-03-28T17:08:06.293Z (about 2 months ago)
- Topics: graphql, graphql-ts, graphql-typescript, javascript, js, ts, typescript, typescript-graphql
- Language: TypeScript
- Homepage:
- Size: 1.25 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Search Engine Site (GraphQL-based) in TypeScript and NestJS
This is a search engine site built using TypeScript and NestJS, with a GraphQL API. The application allows users to search for content and retrieve relevant results. It utilizes the power of GraphQL for efficient querying and retrieving data from various sources.
## Features
- Search for content using keywords or phrases
- Retrieve relevant search results based on the query
- Support for advanced search filters and sorting options
- Pagination for browsing through search results
- Integration with various data sources for retrieving content
- Full-text search capabilities for accurate and fast results
- User authentication and authorization for personalized search experiences
- Filters could be these things : (Category or Type : string , Date Range : {from : Time , to : Time} , Location : string, Price Range : {from : number, to : number} , Rating or Reviews : )
## Requirements
- Node.js (v12 or above)
- TypeScript (v4 or above)
- NestJS (v8 or above)
- MongoDB or any other supported database for data storage
## Getting Started
Clone the repository:
```shell
https://github.com/BaseMax/GoogleCloneGraphQLTS
cd GoogleCloneGraphQLTS
```
Install the dependencies:
```shell
npm install
```
Configure the environment variables:
- Rename the .env.example file to `.env`.
- Modify the values in the .env file according to your setup.
- Ensure you provide the necessary credentials and configurations for the database.
- Build the application:
```shell
npm run build
```
## GraphQL
### Queries
- `search(query: String!, filters: SearchFilters, pagination: PaginationInput): SearchResult`: Retrieves search results based on the provided query string and optional filters and pagination.
- `getSearchResult(id: ID!): SearchResult`: Retrieves a specific search result by its unique identifier.
- `getUserSearchHistory(userId: ID!): [SearchHistory]`: Retrieves the search history of a specific user.
- `getPopularSearches: [String]`: Retrieves a list of popular search terms or queries.
### Mutations
- `createUserSearchHistory(userId: ID!, query: String!): SearchHistory`: Creates a new search history entry for a user with the provided query string.
- `clearUserSearchHistory(userId: ID!): Boolean`: Clears the search history of a specific user.
- `createSearchResult(title: String!, url: String!, description: String!): SearchResult`: Creates a new search result with the provided title, URL, and description.
- `updateSearchResult(id: ID!, title: String, url: String, description: String): SearchResult`: Updates an existing search result identified by its unique identifier with the provided fields.
- `deleteSearchResult(id: ID!): Boolean`: Deletes a search result identified by its unique identifier.
## GraphQL Examples
### search(query: String!, filters: SearchFilters, pagination: PaginationInput): SearchResult
Example usage:
```graphql
query {
search(query: "cat videos", filters: { category: "videos" }, pagination: { page: 1, limit: 10 }) {
totalCount
results {
id
title
url
description
}
}
}
```
### getSearchResult(id: ID!): SearchResult
Example usage:
```graphql
query {
getSearchResult(id: "abc123") {
id
title
url
description
}
}
```
### getUserSearchHistory(userId: ID!): [SearchHistory]
Example usage:
```graphql
query {
getUserSearchHistory(userId: "user123") {
id
query
createdAt
}
}
```
### getPopularSearches: [String]
Example usage:
```graphql
query {
getPopularSearches
}
```
### createUserSearchHistory(userId: ID!, query: String!): SearchHistory
Example usage:
```graphql
mutation {
createUserSearchHistory(userId: "user123", query: "kittens") {
id
query
createdAt
}
}
```
### clearUserSearchHistory(userId: ID!): Boolean
Example usage:
```graphql
mutation {
clearUserSearchHistory(userId: "user123")
}
```
### createSearchResult(title: String!, url: String!, description: String!): SearchResult
Example usage:
```graphql
mutation {
createSearchResult(title: "Funny Cat Videos", url: "https://example.com/videos", description: "Watch hilarious cat videos!") {
id
title
url
description
}
}
```
### updateSearchResult(id: ID!, title: String, url: String, description: String): SearchResult
Example usage:
```graphql
mutation {
updateSearchResult(id: "abc123", title: "New Title") {
id
title
url
description
}
}
```
### deleteSearchResult(id: ID!): Boolean
Example usage:
```graphql
mutation {
deleteSearchResult(id: "abc123")
}
```
Copyright 2023, Max Base