{"id":16668632,"url":"https://github.com/csurfer/faq","last_synced_at":"2025-10-14T07:42:25.402Z","repository":{"id":143283490,"uuid":"76921786","full_name":"csurfer/faq","owner":"csurfer","description":"Minimalistic search app for Frequently Asked Questions with Markdown support.","archived":false,"fork":false,"pushed_at":"2018-12-13T01:45:34.000Z","size":686,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-03T23:34:20.106Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csurfer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"zenodo":null}},"created_at":"2016-12-20T04:04:39.000Z","updated_at":"2020-03-19T01:51:55.000Z","dependencies_parsed_at":"2023-07-31T22:47:10.323Z","dependency_job_id":null,"html_url":"https://github.com/csurfer/faq","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/csurfer/faq","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Ffaq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Ffaq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Ffaq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Ffaq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csurfer","download_url":"https://codeload.github.com/csurfer/faq/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Ffaq/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018217,"owners_count":26086308,"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","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"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-10-12T11:26:13.661Z","updated_at":"2025-10-14T07:42:25.397Z","avatar_url":"https://github.com/csurfer.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# faq\n\n[![Licence](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/csurfer/faq/master/LICENSE)\n\nMinimalistic search app for Frequently Asked Questions with Markdown support built on [Elasticsearch](https://www.elastic.co/) using [Nodejs](https://nodejs.org/en/), [Angularjs](https://angularjs.org/) and [Bootstrap](http://getbootstrap.com/).\n\n# Features\n:star: Out of the box working.\n\n:star: Markdown fully supported.\n\n:star: Highly responsive.\n\n:star: Mobile friendly.\n\n# Installation pre-requisites\n\n* Ensure you have `npm` installed.\n* Download `zip` of elasticsearch binary [here](https://www.elastic.co/downloads/elasticsearch) and unzip it. Tested on (5.0.2, 5.1.1).\n```bash\n# You can use this command to fetch the zip.\nwget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.1.1.zip\n```\n* Enable CORS calls by adding __[Note: Be careful with the network configuration!]__\n```bash\n# IP of the host where Elasticsearch is running.\nnetwork.host: 1.2.3.4\n\n# Following allows calls from localhost.\n# Change the regex to suit your needs.\nhttp.cors:\n    enabled: true\n    allow-origin: /https?:\\/\\/localhost(:[0-9]+)?/\n```\nto `elasticsearch/config/elasticsearch.yml`.\n\n# Installation\n\n```bash\n# Clone the repository.\ngit clone https://github.com/csurfer/faq.git\n\n# cd into it.\ncd faq\n\n# Install npm dependencies.\nnpm install\n\n# To check its working.\nnpm start\n```\n\n# Using the app\n\n## App Navigation\n![app-navigation](img/s1.png)\n\n## Search\n![search](img/s2.png)\n\n## Creating new article\n![new-article](img/s3.png)\n\n## Editing or Curation using admin mode\n![curation](img/s4.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsurfer%2Ffaq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsurfer%2Ffaq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsurfer%2Ffaq/lists"}