- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- β FAQ (OPTIONAL)
- π License
Welcome to Homey knowledge Base This repository is the primary resource for the knowledge base of Homey, a leading real estate listing agency. Our goal is to provide users with a comprehensive repository of information and articles that address a wide range of questions related to our extensive real estate services. effectively.
Client
Server
Database
- Search Functionality
- Our knowledge base features a powerful search bar to help users quickly find relevant information. As users start typing a question, they will receive suggestions with relevant keywords to streamline the search process
- Article Suggestions
- To enhance user experience, the search results include a list of suggested articles based on the entered keywords. This feature aims to guide users towards relevant information and answers.
- Submit a question
- If a user's question cannot be found through the search, a form will prompt them to submit their question along with their email address. This ensures that we can reach out to them with the necessary information.
- Search Analytics
- We have incorporated analytics to provide insights into user behavior. This includes tracking recent searches and identifying popular search queries. These analytics help us understand user preferences and tailor the knowledge base to their needs.
Project has been deployed in render
To get a local copy up and running, follow these steps.
In order to run this project you need:
- npm
- Ruby
- Ruby on rails
- React
- PostgreSQL
Clone this repository to your desired folder:
cd my-folder
git clone https://github.com/kessio/homey-knowledgebase.git
Install this project with:
cd my-project
bundle install
cd react
npm install
To run the project, execute the following command:
cd my-project
rails db:create
rails db:migrate
rails db:seed
rails s
cd react
npm run build
To run tests, run the following command:
cd my-project
rspec
cd react
npm run test
You can deploy this project using:
cd my-project
./bin/render-build.sh
cd react
./render-build.sh
Mention all of the collaborators of this project.
π€ Sharon kessio
- GitHub: @kessio
- Twitter: @kessio_sharon
- LinkedIn: LinkedIn
Describe 1 - 3 features you will add to the project.
- User Feedback Intergration - Implement a feedback system where users can rate the helpfulness of articles. This data can help prioritize and improve content.
- Chatbot Intergration - Integrate a chatbot to provide real-time assistance to users who do not find answers to their questions.
- User Account and Personalization - Allow users to create accounts to personalize their experience, bookmark articles, and receive updates relevant to their preferences.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project give it a βοΈ
I got the inspiration for this project from HelpJuice a leading knowledge base software providers
This project is MIT licensed.