Skip to content

Files

Latest commit

faraaz-baigfaraaz-baig
Update readme.md
Jun 25, 2021
70f45b4 · Jun 25, 2021

History

History
194 lines (122 loc) · 4.25 KB

readme.md

File metadata and controls

194 lines (122 loc) · 4.25 KB

Olloor


Olloor

"a tool that lets you search web using CLI like commands, written in [rust]"
View Demo

About the Project

Olloor is a tool that lets you search web using CLI like commands and written in rust.

Demo

Olloor demo

This is what olloor looks like in action.

Built With

Manual Setup

Prerequisites

Make sure you have Rust installed.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Rocket uses the nightly version of Rust so make sure you use that. If you'd like to only use nightly for this project, you can run this from the root of the project after cloning.

# from the root of the project
rustup override set nightly

Installation

  1. Clone the olloor
git clone https://github.com/faraaz-baig/olloor.git
  1. Make sure you're using nightly
cargo --version
  1. Build the project
cargo build
  1. Follow the instructions in the Running section.

VSCode Dev Container Setup

Prerequisites

This requires VSCode, Docker and the Remote Development extension pack. For more details see the official docs.

Spinning Up The Environment

  • Follow the official guide to open this repository inside a dev container. VSCode will read the config file provided to auto-install relevant dependencies and extensions.
  • To run terminal commands, use the integrated terminal functionality.

Running

  1. Run the project
cargo run
  1. Visit localhost:8000
  2. To test a command, go to localhost:8000/search?cmd=tw and you should be redirected to Twitter

Testing

Run the following command

cargo test

Usage

To test out a command, type in http://localhost:8000/search?cmd= followed by your command.

The following commands are supported by Olloor:

  • "tw" -> redirects to twitter.com
  • "tw @username" -> redirects to twitter.com/username
  • "gh" -> redirects to github.com
  • "gh username" -> redirects to github.com/username
  • "gh username/repo" -> redirects to github.com/username/repo

Everything else redirects to a google search with your query.

Updates

Olloor currently supports on top websites visited around the globe.

  • Search Engines

    • Duckduckgo (Default)
    • Google
    • Yandex

  • Entertainment & Media

    • Youtube
    • Twitch
    • Netflix
    • Zoom

  • Shopping

    • Amazon
    • Wish
    • Flipkart

  • Social

    • Facebook
    • Instagram
    • Twitter
    • Reddit
    • Linkedin
    • Pinterest

  • Developers & Designers

    • Github
    • Hacker News
    • Dribbble
    • Gitlab
    • Stack Overflow
    • Wikipedia

  • Tools

    • Weather
    • Calculator

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. See CONTRIBUTING for more information.

License

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

Contact

If you have questions or thoughts on this project, feel free to send them my way by @faraazofficial'ing me on Twitter or shooting me a DM.

Faraaz Baig - @faraazofficial

Acknowledgements