{"id":25807147,"url":"https://github.com/harsh-panchal-804/faq-backend","last_synced_at":"2026-05-12T08:34:59.264Z","repository":{"id":275294907,"uuid":"925662663","full_name":"harsh-panchal-804/FAQ-Backend","owner":"harsh-panchal-804","description":"FAQ Backend API - A powerful backend API for managing FAQs with multi-language support, automatic translations via Google Translate API and Redis caching for fast responses. Built with Node.js, Express.js, MongoDB, and Redis. 🚀","archived":false,"fork":false,"pushed_at":"2025-02-01T16:21:47.000Z","size":10518,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T16:23:47.506Z","etag":null,"topics":["google-translate-api","redis-cache"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harsh-panchal-804.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-02-01T12:34:45.000Z","updated_at":"2025-02-01T16:21:51.000Z","dependencies_parsed_at":"2025-02-01T16:23:54.683Z","dependency_job_id":null,"html_url":"https://github.com/harsh-panchal-804/FAQ-Backend","commit_stats":null,"previous_names":["harsh-panchal-804/bharatfd-backend","harsh-panchal-804/faq-backend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsh-panchal-804%2FFAQ-Backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsh-panchal-804%2FFAQ-Backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsh-panchal-804%2FFAQ-Backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsh-panchal-804%2FFAQ-Backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harsh-panchal-804","download_url":"https://codeload.github.com/harsh-panchal-804/FAQ-Backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241059663,"owners_count":19902418,"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":["google-translate-api","redis-cache"],"created_at":"2025-02-27T20:59:18.013Z","updated_at":"2026-05-12T08:34:59.217Z","avatar_url":"https://github.com/harsh-panchal-804.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FAQ Backend API\n\nWelcome to the FAQ Backend API ! This project allows you to manage FAQs with multi-language support and caching.\n\n## Features\n\n- **Multi-language support**: FAQs can be translated into different languages with automatic translation using Google Translate API.\n\n- **Caching**: Translations are cached using **Redis** for faster response times.\n- **RESTful API**: Allows CRUD operations for FAQs, with dynamic language selection.\n- **Admin Panel**: User-friendly interface for managing FAQs.\n- **Testing**: Unit tests for model methods and API responses.\n- **Documentation**: A detailed README with API usage and contribution guidelines.\n\n\n## Demo\n\n![Demo GIF](/demo_gif/faq-video.gif)\n\n\n\n## Tech Stack\n\n### Backend\n- **Node.js**: JavaScript runtime for building scalable applications.\n- **Express.js**: Web framework for Node.js to create the REST API.\n- **MongoDB**: NoSQL database for storing FAQ data.\n- **Redis**: In-memory data store for caching translations.\n- **Google Translate API**: Used for automatic translation of FAQ questions and answers.\n\n\n### Other Tools\n- **ESLint**: For enforcing code quality standards.\n- **dotenv**: For environment variable management.\n- **Mongoose**: MongoDB object modeling for Node.js.\n\n\n## Installation\n\nFollow these steps to set up the project locally:\n\n### Prerequisites\n- Node.js (v14 or later)\n- MongoDB (local or cloud)\n- Redis (local or cloud)\n\n\n### Steps\n\n1. **Clone the Repository**\n   ```bash\n    git clone https://github.com/harsh-panchal-804/FAQ-Backend\n   ```\n\n2. **Install backend dependencies**\n    ```\n    cd faq-backend\n    npm install\n    ```\n\n3. **Set Up Environment Variables** \n    Create a .env file in the root directory of your project with the following keys:\n\n    \n\n    **.env File:**\n\n    ```\n    MONGO_URI=your-mongodb-connection-string\n    REDIS_URL=your-redis-connection-string\n    PORT=3000\n    ```\n\n4. **Run The Application** \n    ```\n    node express.js\n    \n    ```\n    \n\n# FAQ API Usage Examples\n\nThe FAQ API allows you to manage FAQs with multi-language translation support.\n\n## 1. Fetch FAQs (Default: English)\n1. To get the list of all FAQs in English (default):\n\n```\n    curl http://localhost:3000/faqs/\n```\n2. Fetch FAQs in a Specific Language\n\nTo fetch FAQs in Hindi:\n```\n    curl http://localhost:3000/faqs/?lang=hi\n```\nTo fetch FAQs in Bengali:\n```\n    curl http://localhost:3000/faqs/?lang=bn\n```\n3. Create a New FAQ\nTo create a new FAQ, send a POST request with a question and answer:\n```\n    curl -X POST http://localhost:3000/faqs/ \\\n        -H \"Content-Type: application/json\" \\\n        -d '{\"question\": \"What is Node.js?\", \"answer\": \"Node.js is a runtime for executing JavaScript\"\n  ```\nOr go to the /admin route (http://localhost:3000/admin)  and add it manually via an admin page.\n\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharsh-panchal-804%2Ffaq-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharsh-panchal-804%2Ffaq-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharsh-panchal-804%2Ffaq-backend/lists"}