Skip to content

Latest commit

 

History

History
177 lines (125 loc) · 9.51 KB

README.md

File metadata and controls

177 lines (125 loc) · 9.51 KB

1️⃣ WebSearch Project

Maintenance License: MIT Open Source Love svg1 HitCount Awesome

⭐ Star us on GitHub — it helps!

Hi! For TWT's August Code-Jam we were tasked to create a "generator" themed project. Our team, Shivansh , FunkyMonkey, NMarco, wowzers, decided to create a website generator. Our project will ask the user for an input and then return a website on it with a definition, some fun facts on it, Youtube videos, news articles and relevant images. Have Fun!

Contributors

Shivansh FunkyMonkey NMarco wowzers

Table of Contents

Installation

Clone

  • Clone this repo to your local machine using https://github.com/Shivansh-007/TWT-Code-Jam

Linux

$ sudo apt-get install python3.8-venv
$ python3.8 -m venv venv

Move all the files from the cloned folder to this virtual venv

$ git clone https://github.com/Shivansh-007/WebSearch.git
$ cd WebSearch
$ pip install -r requirements.txt
$ . bin/activate
$ export FLASK_ENV=development
$ export FLASK_APP=server.py
$ flask run

Windows

!! open PowerShell as Administrator

> git clone https://github.com/Shivansh-007/WebSearch.git
> cd \cloned\repository
> Set-ExecutionPolicy Unrestricted -Force
> py -m pip install -r requirements.txt
> py -m pip install --upgrade pip
> py -m pip install --user virtualenv

Following commands always inside the cloned repository folder

> py -m venv env
> .\env\Scripts\activate

Run the app

> $env:FLASK_APP = "server.py"
> flask run

Usage

Once everything is set, the command line should run like the following (example for Windows)

Picture

Just copy the url and paste it into browser and go!

Setting Up APIs for YouTube (check how to do it) 💁

Setting up the YouTube APIs!!

Picture

  • Fill in whatever Project Name you want.

Picture

  • Then click GoogleAPIs link in the top left corner and then click the link option called “YouTube Data API v3” It’s under YouTube API’s. You can see it below:

Picture

  • Now click on the “ENABLE” button.
  • Next click on the blue ‘Go to Credentials’ button to the right.

Picture

  • Choose the select option YouTube Data API v3 for the first select option and Web server(e.g. node js. Tomcat) for the second selection. Then choose Public data. Now click the blue button, “What credentials do I need?.”

Picture

  • Almost done, wait for google to create your new project and you should see the screen below where you can copy your API Key.

Picture

  • Copy the API Key (it will be requested by the terminal)

Examples

Search Page

Enter the topic you'd like to look for and press ENTER

Picture

Results Page

Picture

Picture

Of course, sometimes something can go wrong

404 error page

Picture

ScreenRecording

To be Done

License

MIT License

Copyright (c) 2020 Sachin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Links And Resourcse