Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update read me file #17

Closed
Vipullakum007 opened this issue May 11, 2024 · 9 comments
Closed

update read me file #17

Vipullakum007 opened this issue May 11, 2024 · 9 comments
Assignees

Comments

@Vipullakum007
Copy link

you can update readme file

@AbhishekSingh-22
Copy link
Contributor

I would like to update the readme file for better understanding as a part of GSSOC'24. Please assign me this issue as well as label the issue.

@SiddharthBahuguna
Copy link
Owner

SiddharthBahuguna commented May 11, 2024 via email

@AbhishekSingh-22
Copy link
Contributor

Please assign me this issue under GSSOC'24. I haven't be assigned this issue till now. I will make the following changes in the readme file

NEWS-AGGREGATOR-PROJECT

Overview ✳️

The news aggregator project aims to create a centralized platform that curates and organizes news articles and updates from various sources across the internet. It is being developed to address the growing need for a consolidated and user-friendly platform that offers reliable and diverse news content.

Features 😱

  • Centralized Platform: All your news sources in one place.
  • Customizable: Choose the sources and topics you're interested in.
  • User-Friendly Interface: Easy navigation and intuitive design.
  • Reliable: Dependable news updates from reputable sources.
  • Diverse Content: Access news articles from a wide range of sources.

Prerequisites

  • Python 3.x installed on your machine
  • pip (Python package manager)

Steps For Contribution⚡

  1. Star ⭐

  2. Fork

  3. Clone the forked repository.

git clone https://github.com/<your-github-username>/NEWS-AGGREGATOR-PROJECT.git
  1. Navigate to the project directory.
cd NEWS-AGGREGATOR-PROJECT
  1. Install virtualenv library
pip install virtualenv
  1. Create virtual environment
virtualenv venv
  1. Activate virtual environment
  • For Windows:
venv\Scripts\activate
  • For Unix/Linux/MacOS:
source venv/bin/activate
  1. Install required dependencies
pip install -r requirements.txt
  1. Create a new branch.
git checkout -b <your_branch_name>
  1. Make changes.

  2. Stage your changes and commit

git add -A

git commit -m "<your_commit_message>"
  1. Push your local commits to the remote repo.
git push -u origin <your_branch_name>
  1. Create a Pull Request.

  2. Congratulations! 🎉 you've made your contribution.

Screenshots 📷

Home Page
Home Page

About Page
About Page

Also Please add labels for this issue as well.

@SiddharthBahuguna
Copy link
Owner

SiddharthBahuguna commented May 12, 2024 via email

@AbhishekSingh-22
Copy link
Contributor

Please add a GSSOC'24 label as well as the corresponding level for this issue as If the label isn't found then the points won't be counted for the respective contributions. Please add the labels for each issue not only this one.

@AbhishekSingh-22
Copy link
Contributor

Sorry to bother again @SiddharthBahuguna but the label should be as gssoc and level1, not as GSSOC'24 and Level-1. Could you please change this. Thank you.

@SiddharthBahuguna
Copy link
Owner

now check @AbhishekSingh-22

@AbhishekSingh-22
Copy link
Contributor

now check @AbhishekSingh-22

Thank you so much.

@SiddharthBahuguna
Copy link
Owner

SiddharthBahuguna commented May 17, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants