{"id":19307391,"url":"https://github.com/artefactory/redis-hackathon-team-name-not-defined","last_synced_at":"2026-06-10T16:31:41.945Z","repository":{"id":103035252,"uuid":"558955363","full_name":"artefactory/redis-hackathon-team-name-not-defined","owner":"artefactory","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-28T17:18:41.000Z","size":597,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"development","last_synced_at":"2025-02-24T02:49:50.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","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/artefactory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2022-10-28T17:17:02.000Z","updated_at":"2022-10-28T17:18:46.000Z","dependencies_parsed_at":"2023-03-13T15:09:46.719Z","dependency_job_id":null,"html_url":"https://github.com/artefactory/redis-hackathon-team-name-not-defined","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/artefactory/redis-hackathon-team-name-not-defined","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredis-hackathon-team-name-not-defined","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredis-hackathon-team-name-not-defined/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredis-hackathon-team-name-not-defined/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredis-hackathon-team-name-not-defined/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artefactory","download_url":"https://codeload.github.com/artefactory/redis-hackathon-team-name-not-defined/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredis-hackathon-team-name-not-defined/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34161283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2024-11-10T00:10:46.719Z","updated_at":"2026-06-10T16:31:41.924Z","avatar_url":"https://github.com/artefactory.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/RedisVentures/redis-arXiv-search\"\u003e\u003cimg src=\"https://github.com/RedisVentures/redis-arXiv-search/blob/main/backend/vecsim_app/data/redis-logo.png?raw=true\" width=\"30%\"\u003e\u003cimg\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n\u003cdiv display=\"inline-block\"\u003e\n    \u003ca href=\"https://docsearch.redisventures.com\"\u003e\u003cb\u003eHosted Demo\u003c/b\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca href=\"https://github.com/RedisVentures/redis-arXiv-search\"\u003e\u003cb\u003eCode\u003c/b\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca href=\"https://datasciencedojo.com/blog/ai-powered-document-search/\"\u003e\u003cb\u003eBlog Post\u003c/b\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca href=\"https://redis.io/docs/stack/search/reference/vectors/\"\u003e\u003cb\u003eRedis VSS Documentation\u003c/b\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003c/div\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n\u003c/div\u003e\n\n# Redis arXiv Search\n*This repository is the official codebase for the arxiv paper search app hosted at: **https://docsearch.redisventures.com***\n\nThrough the RediSearch module, vector data types and search indexes can be added to Redis. This turns Redis into\na highly performant, in-memory, vector database, which can be used for many types of applications.\n\n___\n\nHere we showcase Redis vector similarity search (VSS) applied to a document search/retrieval use case. Read more about AI-powered search in [our blog post](https://datasciencedojo.com/blog/ai-powered-document-search/) (shout out to our friends at Data Science Dojo).\n\n\n![Screen Shot 2022-09-20 at 12 20 16 PM](https://user-images.githubusercontent.com/13009163/191346916-4b8f648f-7552-4910-ad4e-9cc117230f00.png)\n\n\n## Getting Started\nThe steps below outline how to get this app up and running on your machine.\n\n## Docker\nInstall [Docker Desktop](https://www.docker.com/products/docker-desktop/).\n\n## Download arXiv Dataset\n\nPull the arXiv dataset from the the following [Kaggle link](https://www.kaggle.com/Cornell-University/arxiv).\n\nDownload and extract the zip file and place the resulting json file (`arxiv-metadata-oai-snapshot.json`) in the `data/` directory.\n\n## Embedding Creation\n\n**1. Setup python environment:**\n- If you use conda, take advantage of the Makefile included here: `make env`\n- Otherwise, setup your virtual env however you wish and install python deps in `requirements.txt`\n\n**2. Use the notebook:**\n- Run through the [`arxiv-embeddings.ipynb`](data/arxiv-embeddings.ipynb) notebook to generate some sample embeddings.\n\n\n## Application\n\nThis app was built as a Single Page Application (SPA) with the following components:\n\n- **[Redis Stack](https://redis.io/docs/stack/)**: Vector database + JSON storage\n- **[FastAPI](https://fastapi.tiangolo.com/)** (Python 3.8)\n- **[Pydantic](https://pydantic-docs.helpmanual.io/)** for schema and validation\n- **[React](https://reactjs.org/)** (with Typescript)\n- **[Redis OM](https://redis.io/docs/stack/get-started/tutorials/stack-python/)** for ORM\n- **[Docker Compose](https://docs.docker.com/compose/)** for development\n- **[MaterialUI](https://material-ui.com/)** for some UI elements/components\n- **[React-Bootstrap](https://react-bootstrap.github.io/)** for some UI elements\n- **[Huggingface Tokenizers + Models](https://huggingface.co/sentence-transformers)** for vector embedding creation\n\nSome inspiration was taken from this [Cookiecutter project](https://github.com/Buuntu/fastapi-react)\nand turned into a SPA application instead of a separate front-end server approach.\n\n### Launch\n\n**To launch app, run the following:**\n- `docker compose up` from the same directory as `docker-compose.yml`\n- Navigate to `http://localhost:8888` in a browser\n\n**Building the containers manually:**\n\nThe first time you run `docker compose up` it will automatically build your Docker images based on the `Dockerfile`. However, in future passes when you need to rebuild, simply run: `docker compose up --build` to force a new build.\n\n### Using a React dev env\nIt's typically easier to manipulate front end code in an interactive environment (**outside of Docker**) where one can test out code changes in real time. In order to use this approach:\n\n1. Follow steps from previous section with Docker Compose to deploy the backend API.\n2. `cd gui/` directory and use `yarn` to install packages: `yarn install --no-optional` (you may need to use `npm` to install `yarn`).\n3. Use `yarn` to serve the application from your machine: `yarn start`.\n4. Navigate to `http://localhost:3000` in a browser.\n5. Make front end changes in realtime.\n\n### Troubleshooting\n\n- Issues with Docker? Run `docker system prune`, restart Docker Desktop, and try again.\n- Open an issue here on GitHub and we will be as responsive as we can!\n\n\n### Interested in contributing?\nThis is a new project. Comment on an open issue or create a new one. We can triage it from there.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartefactory%2Fredis-hackathon-team-name-not-defined","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartefactory%2Fredis-hackathon-team-name-not-defined","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartefactory%2Fredis-hackathon-team-name-not-defined/lists"}