https://github.com/shivansh-007/websearch
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!
https://github.com/shivansh-007/websearch
awesome dictionary hacktoberfest image-scrapping python scraping-websites search-engine website wikipedia wikipedia-api youtube youtube-api
Last synced: 5 months ago
JSON representation
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!
- Host: GitHub
- URL: https://github.com/shivansh-007/websearch
- Owner: Shivansh-007
- License: mit
- Created: 2020-09-01T03:58:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-28T13:33:26.000Z (about 5 years ago)
- Last Synced: 2025-04-29T12:02:03.007Z (about 1 year ago)
- Topics: awesome, dictionary, hacktoberfest, image-scrapping, python, scraping-websites, search-engine, website, wikipedia, wikipedia-api, youtube, youtube-api
- Language: CSS
- Homepage:
- Size: 240 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 1️⃣ WebSearch Project
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://github.com/ellerbrock/open-source-badges/)
[](https://github.com/Shivansh-007/TWT-Code-Jam)
[](https://github.com/sindresorhus/awesome)
:star: 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](https://github.com/Shivansh-007) , [FunkyMonkey](https://github.com/Roshannarma), [NMarco](https://github.com/marco-create), [wowzers](https://github.com/tshe777), 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](https://github.com/Shivansh-007) | [FunkyMonkey](https://github.com/Roshannarma) | [NMarco](https://github.com/marco-create) | [wowzers](https://github.com/tshe777) |
| :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
| [
](https://github.com/Shivansh-007) | [](https://github.com/Roshannarma) | [](https://github.com/marco-create) | [](https://github.com/tshe777) | [](https://github.com/Shivansh-007) |
| [
](https://github.com/Shivansh-007) | [ ](https://github.com/Roshannarma) | [ ](https://github.com/marco-create) | [ ](https://github.com/tshe777) |
| [ 
](https://www.linkedin.com/) | [ ](https://www.linkedin.com/) | [ ](https://www.linkedin.com/in/marco-ninghetto-a0b983142/) | [ ](https://www.linkedin.com/) |
## Table of Contents
- [Installation](#installation)
- [Usage](#Usage)
- [Setting Up APIs](#Setting-Up-APIs)
- [Examples](#Exampl.es)
- [Search Page](#Search-Page)
- [Result](#Results-Page)
- [Screen Recording](#iScreenRecording)
- [License](#License)
- [Links](#Links-And-Resourcse)
## Installation
### Clone
- Clone this repo to your local machine using `https://github.com/Shivansh-007/TWT-Code-Jam`
**Linux**
```shell
$ sudo apt-get install python3.8-venv
$ python3.8 -m venv venv
```
Move all the files from the cloned folder to this virtual venv
```shell
$ 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***
```PowerShell
> 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
```PowerShell
> py -m venv env
> .\env\Scripts\activate
```
Run the app
```PowerShellv
> $env:FLASK_APP = "server.py"
> flask run
```
## Usage
Once everything is set, the command line should run like the following (example for Windows)
Just copy the url and paste it into browser and go!
## Setting Up APIs for YouTube ([check how to do it](https://www.youtube.com/watch?v=th5_9woFJmk&t=185s)) :information_desk_person:
Setting up the YouTube APIs!!
- Go to https://developers.google.com/ and log in or create an account, if necessary.
- After logging in go to this link https://console.developers.google.com/project and click on the blue CREATE PROJECT button as depicted in the photo below. Wait a moment as google prepares your project.
- Fill in whatever Project Name you want.
- 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:
- Now click on the “ENABLE” button.
- Next click on the blue ‘Go to Credentials’ button to the right.
- 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?.”
- Almost done, wait for google to create your new project and you should see the screen below where you can copy your API Key.
- **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
### Results Page
### Of course, sometimes something can go wrong
404 error page
### 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
- [Dictionary API](https://dictionaryapi.com/)
- [Wikipedia Library](https://pypi.org/project/wikipedia/)
- [Wikipedia API](https://pypi.org/project/Wikipedia-API/)
- [How to install Youtube API - easy](https://www.youtube.com/watch?v=th5_9woFJmk&t=185s)
- [Google News API](https://pypi.org/project/GoogleNews/)
- [Older Repo Of This Project 1](https://github.com/Shivansh-007/TWT-Code-Jam/graphs/contributors)
- [Older Repo Of This Project 2](https://github.com/Roshannarma/code_jam/graphs/contributors)