Skip to content

gdscjgec/UpTrend

Repository files navigation

Banner

Logo

UpTrend

A one place destination to check whatever is trending on the top social and news websites at present.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

The motive of this project is to scrape trending stuff from top websites which are mostly visited on a daily basis by users and show them in a single page application consisting of links to trending stuff. For the purpose of hacktoberfest we will be currently focusing on scraping trending data from

  1. Youtube
  2. Reddit
  3. Instagram
  4. CNN top stories
  5. more will be added with progress........

Built With

The dependancies currently consist of the following,

Getting Started

Follow the steps below to set-up the project on your local machine,

Prerequisites

  1. Python (3.6 and above)
  2. pip (python package installer)

Installation

  1. Start by creating a virtual environment for the project by using the following command, python -m venv <name>

  2. Activate the virtual environment by using the following command, <name>/scripts/activate

  3. Install required dependencies from requirements.txt using the following command, pip install -r requirements.txt

    Tip: If you install new dependencies while submiting a PR, please do not forget to update requirements.txt. You can use the following command to save yourself the trouble pip freeze > requirements.txt

  4. Now, you can run the project by using the command python app.py

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to 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. Add your Changes ( git add . )
  4. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
  5. Push to the Branch ( git push origin feature/AmazingFeature )
  6. Open a Pull Request

License

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

Contact

Mail us at - gdsc@jgec.ac.in
Mail maintainer at - ap2301@it.jgec.ac.in