Skip to content

Latest commit

 

History

History
192 lines (139 loc) · 5 KB

README.md

File metadata and controls

192 lines (139 loc) · 5 KB
Raw

Logo

Searchify

Hosting your own Searchengine was never easier
Explore the docs »

View Demo · Report Bug · Request Feature
  Buy Me A Coffee

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. To do
  6. Contributing
  7. License
  8. Contact
  9. Contributors

About The Project

Please notice there is a 100 query limit per day for the google api, so don't be confused if there are no results on the public deploy

Please report inappropriate content that you might be redirected to via a Github Issue with the label url report on the repository or create a pull request with the label url report already having the url removed in the code.

Host your own Google

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm

  • NodeJS

  • yarn

    npm install --global yarn

  • NextJS

    yarn add next react react-dom

Installation

  1. Clone the repo 
    git clone https://github.com/jusoftdev/searchify.git
  2. Install yarn packages 
    yarn
  3. Get your custom Google API key (requires Google Account)
  4. Insert your API key in keys.js
export const API_KEY = 'Insert here'
  1. Run
yarn dev
  1. Build (optional)
yarn build

Usage

Beautiful responsive design Showing results in an useful way Pagination Fully responsive Design

Auto Darkmode

Roadmap

See the open issues for a list of proposed features (and known issues).

Todo (Sorted by importantness)

  • Functionality
  • Image Search
  • Video Search
  • News
  • Settings

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

JuSoft - @jusoftdev - Discord Server - [email protected]

Project Link: https://github.com/jusoftdev/searchify

Contributors