atakishiyev-yusif/artadosearch

Artado Search is open source, private and highly customizable search engine

Artado Search

Artado Search is a versatile and highly customizable search engine, designed to empower users with the ability to tailor their search experience to their unique needs. This project is based on the ASP.NET Framework and is proudly open source under the AGPL v3 license. It not only offers its own search results but also integrates results from other search engines, providing a comprehensive search solution.

Features

• Customizability: Artado Search goes beyond traditional search engines by offering extensive customization options. You can create personalized themes and extensions to enhance the user interface and functionality.

• Combined Results: In addition to its own search algorithms, Artado Search aggregates results from other search engines, providing users with a holistic perspective and access to a wider range of information.

• Multi-language Support: Artado Search supports over 20 languages out of the box. Users have the ability to contribute additional languages or correct translation errors to make the search experience more inclusive and accurate.

• Developer-Friendly: Artado Search's extensibility is one of its core strengths. Developers can create and publish themes, extensions, and logos through the Artado Developers platform. Themes are crafted using CSS, while extensions are powered by JavaScript.

Getting Started

Follow these steps to get Artado Search up and running on your system:

1. Prerequisites: Make sure you have the ASP.NET Framework 4.8 installed on your machine.

2. Clone the Repository: Clone this repository to your local environment using the following command:

   git clone https://github.com/Artado-Project/artadosearch

3. Configuration: Configure the database connection in web.config as to adapt Artado Search to your specific use case. Copy the Web.example.config to Web.config and fill in the database parameters.

   <connectionStrings>
      <add name="con" connectionString="" />
      <add name="admin" connectionString="" />
      <add name="service" connectionString="" />
   </connectionStrings>

Also change the parameters in Config.cs. Copy the Config.example.cs to Config.cs and fill in the parameters.

4. Build and Launch: Utilize your preferred development environment or the command line to build the project. Once built, start the application and access the search engine via your web browser.

5. Development: If you're interested in creating themes or extensions for Artado Search, refer to the Developer Documentation for comprehensive guidelines.

Contributing

We welcome contributions from the community to enhance Artado Search's capabilities. If you want to contribute, please follow the contribution guidelines. To contribute:

1. Fork the repository and create a new branch from main.

2. Implement your changes, whether it's fixing issues, introducing new features, or improving existing functionality.

3. Ensure your changes are covered by tests, maintaining the integrity of the existing test suite.

4. Open a pull request, providing detailed insights into your changes and their purpose.

5. Engage in discussions with reviewers and maintainers to address any feedback or queries.

Language Contributions

If you're interested in contributing translations or correcting existing ones:

1. Visit the Translation Documentation for information on how to contribute new languages or improve existing translations.

License

Artado Search operates under the AGPL v3 license, which mandates that any modifications or derivatives must also be open source and adhere to the AGPL v3.

Contact

For inquiries, collaboration opportunities, or any concerns, reach out to us at [email protected].

---

Explore the possibilities of Artado Search, and join us in building a search engine that adapts to your preferences and helps you discover information efficiently. Your contributions make a difference!