{"id":13593219,"url":"https://github.com/vgulerianb/DocNavigator","last_synced_at":"2025-04-09T02:32:54.245Z","repository":{"id":168380630,"uuid":"637198626","full_name":"vgulerianb/DocNavigator","owner":"vgulerianb","description":"AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites","archived":false,"fork":false,"pushed_at":"2023-10-23T04:42:41.000Z","size":10924,"stargazers_count":119,"open_issues_count":0,"forks_count":18,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-30T03:47:14.222Z","etag":null,"topics":["ai","chat-applications","chatbot","chatbot-framework","docnavigator","openai","supabase"],"latest_commit_sha":null,"homepage":"https://docnavigator.in","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vgulerianb.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}},"created_at":"2023-05-06T20:11:45.000Z","updated_at":"2024-10-12T08:14:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"deb06623-af4e-47e1-b3d7-c0446c708dd4","html_url":"https://github.com/vgulerianb/DocNavigator","commit_stats":null,"previous_names":["vgulerianb/docnavigator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vgulerianb%2FDocNavigator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vgulerianb%2FDocNavigator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vgulerianb%2FDocNavigator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vgulerianb%2FDocNavigator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vgulerianb","download_url":"https://codeload.github.com/vgulerianb/DocNavigator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247965743,"owners_count":21025430,"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":["ai","chat-applications","chatbot","chatbot-framework","docnavigator","openai","supabase"],"created_at":"2024-08-01T16:01:17.924Z","updated_at":"2025-04-09T02:32:49.237Z","avatar_url":"https://github.com/vgulerianb.png","language":"TypeScript","funding_links":[],"categories":["开源项目","Open Source Projects"],"sub_categories":["知识管理","Knowledge Management"],"readme":"# DocNavigator\n\n![DocNavigator](https://github.com/vgulerianb/DocNavigator/assets/90599235/3c066058-a383-473b-b31f-676a69b5ebef)\n\nDocNavigator is an AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites. It can be trained on the data available on the company's website, making it a scalable solution for organizations of any size.\n\nWith its ability to handle multiple queries at once, DocNavigator can save customers time and boost productivity, all while improving customer satisfaction.\n\nTo get started with this project, you will need to create a `.env` file. An example `.env` file can be found in the `example.env`. The `.env` file accepts the following variables:\n\n- `APP_URL`: The root path where your app is hosted. say https://localhost:3000\n- `OPENAI_API_KEY`: The API key for OpenAI.\n- `NEXT_PUBLIC_SUPABASE_URL`: The URL for your Supabase instance. //Create new project on supabase for this\n- `SUPABASE_SERVICE_ROLE_KEY`: The service role key for your Supabase instance. //Create new project on supabase for this\n- `APP_SECRET`: The secret key for signing JWT tokens.\n- `USER_SIGNUP_LIMIT`: The limit for additional signups.\n- `DATABASE_URL`: The connection string for your Supabase database. //Create new project on supabase for this\n\nBefore building and running the Docker container, you will need to initialize the database by running the following command:\n\n```bash\n# Initialize the database\nyarn run initDb\n```\n\nThis will create the necessary tables and data in your Supabase database.\n\nOnce you have created your `.env` file and initialized the database, you can run the following commands to start the project:\n\nUse docker\n\n```bash\n# Build the Docker image\ndocker build -t doc-navigator .\n\n# Run the Docker container\ndocker run -p 3000:3000 doc-navigator\n```\n\nOr start locally\n\n```bash\n# Install dependencies\nyarn install\n\n# Build the application\nyarn build\n\n# Start the webapp\nyarn start\n```\n\nThis will run the app, exposing port 3000 for the application. You can then access the application by navigating to `http://localhost:3000` in your web browser.\n\n## Contributing\n\nIf you would like to contribute to this project, please follow these steps:\n\n1. Fork the repository\n2. Create a new branch (`git checkout -b feature/my-new-feature`)\n3. Make your changes\n4. Commit your changes (`git commit -am 'Add some feature'`)\n5. Push to the branch (`git push origin feature/my-new-feature`)\n6. Create a new Pull Request\n\n## Star History\n[![Star History Chart](https://api.star-history.com/svg?repos=vgulerianb/docnavigator\u0026type=Date)](https://star-history.com/#vgulerianb/docnavigator\u0026Date)\n\n\n## License\n\nThis project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvgulerianb%2FDocNavigator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvgulerianb%2FDocNavigator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvgulerianb%2FDocNavigator/lists"}