Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 2.15 KB

README.md

File metadata and controls

45 lines (33 loc) · 2.15 KB

Cpix

Cpix is a custom search engine that operates offline, providing you with unparalleled privacy and control over your search experience. Say goodbye to sending your search queries and personal data to remote servers – with Cpix, everything happens right on your device.

For a visual introduction, check out my YouTube video: https://youtu.be/wIa6YTm-_iY


🧰 Getting Started

Visual Studio Code is recommended.

Start by cloning the repository with git clone https://github.com/Light-Lens/Cpix.git

⚙️ Instructions

‼️ Requirments

You need to install the following on your machine.

Create an environment and Activate it

Whatever you prefer (e.g. conda or venv)

cd WINTER
$ python -m venv .venv
$ .venv\Scripts\activate

Install dependencies

$ pip install -r requirements.txt

📝 Features

  • Offline Operation: Cpix operates entirely offline, ensuring that your search queries and personal information remain secure and private.
  • Customization: Tailor your search experience by fine-tuning search algorithms, sources, and filters according to your preferences.
  • Instant Indexing: Cpix's lightning-fast indexing system ensures that newly added content becomes searchable almost instantly.
  • Open Source: Cpix is an open-source project, giving you the freedom to examine, modify, and contribute to its development.

⚠️ License and Contributions

All code is licensed under an MIT license. This allows you to re-use the code freely, remixed in both commercial and non-commercial projects. The only requirement is to include the same license when distributing.

We welcome any contributions to Cpix Search Engine development on GitHub. Our development is ongoing and making great progress, but some features may not be fully implemented yet. If you encounter any bugs or have any suggestions, please feel free to open an issue or submit a pull request. Your contributions are greatly appreciated! Most of our active development is in the master branch, so we prefer to take pull requests there.