Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.46 KB

README.md

File metadata and controls

38 lines (22 loc) · 1.46 KB

HNSSearch frontend

hnssearch is an open-source search engine for the Handshake community. It is currently in alpha and is being actively developed.

The search engine is built using React, and utilizes MeiliSearch as the search client. The goal of hnssearch is to provide a fast and accurate way for users to search through handshake domains.

If you're interested in contributing to the development of hnssearch, please feel free to submit pull requests or open an issue on the GitHub repository. We're always looking for ways to improve the project.

Please note that this project is under active development, so there may be bugs and missing features. We appreciate your feedback and patience as we continue to improve the project.

Installation

In order to use hnssearch, you will need to have Node.js and npm installed on your machine. Once you have those set up, you can clone the repository and install the dependencies:

git clone https://github.com/hnssearch/hnssearch-frontend.git
cd hnssearch
npm install

Usage

To start the development server, run:

npm start

This will start the development server on http://localhost:3000. You can access the search engine by navigating to that address in your web browser.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines.

License

hnssearch is licensed under the MIT License. See LICENSE for more information.