An open API service indexing awesome lists of open source software.

https://github.com/anush008/qdrant-npm

Helper package to spin-up a Qdrant instance without Docker
https://github.com/anush008/qdrant-npm

qdrant qdrant-vector-database vector-database

Last synced: about 1 month ago
JSON representation

Helper package to spin-up a Qdrant instance without Docker

Awesome Lists containing this project

README

          


Qdrant-NPM


NPM package to run a Qdrant DB instance for development without Docker.




GitHub code size in bytes
GitHub commit activity

GitHub issues

![qdrant-npm](https://github.com/Anush008/qdrant-npm/assets/46051506/812907e6-0a34-4dfb-ba01-8f7420579083)

## Installation

To install qdrantdb globally, use npm:

```bash
npm i -g qdrantdb
```

## Usage

Once qdrantdb is installed, you can run the Qdrant DB instance by using the following command:

```bash
qdrant
```

Please note that depending on your system configuration, you may need to run this command with sudo privileges.

## Features

- Supports Linux, macOS, and Windows.
- Versions are in parity with the Qdrant binary release versions
- Automatically fetches the appropriate Qdrant DB binary for your platform and architecture.
- Sets up the necessary configuration files and dashboard.
- Cleans up unnecessary node_modules after installation.

## Installation Structure

After running qdrantdb, your installation directory will look like this:

```
bin/
├── config/
├── snapshot/
├── static/
├── storage/
├── qdrant/
├── .qdrant-initialized
install.js
runner.js
package.json
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

Contributions to qdrantdb are welcome! If you have any ideas, enhancements, or bug fixes, please open an issue or submit a pull request.

## Issues and Support

If you encounter any issues or need assistance with Qdrant, please open an issue on the [GitHub repository](https://github.com/qdrant/qdrant/issues) or reach out to the [community](https://github.com/qdrant/qdrant/discussions).