From 6c51002f10ed33c3b2da221eeb42cc2062cc2d02 Mon Sep 17 00:00:00 2001 From: Rushil Umaretiya Date: Sun, 16 Aug 2020 11:48:52 -0400 Subject: [PATCH 1/4] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index a248629..0cad6a4 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,41 @@ HackDefy submission 2020 ![GitHub repo size](https://img.shields.io/github/repo-size/rushilwiz/newviewsnews?color=9EE09E) ![GitHub](https://img.shields.io/github/license/rushilwiz/newviewsnews?color=9EC1CF) ![GitHub last commit](https://img.shields.io/github/last-commit/rushilwiz/newviewsnews?color=CC99C9) + +## Inspiration +Our project was inspired by the evergrowing activism community in our country that becoming is more and more toxic every year due to closemindedness and echo chambers. This has resulted in a society that has more conflict and is less understanding of people with different opinions and political viewpoints. + +NewViewsNews paves the way toward the solution to this issue by giving users a way to view articles and political arguments that are opposite to their beliefs. More people can escape their echo chambers and view other perspectives, resulting in a potentially more open-minded and understanding society. + +## What it does +NewViewsNews forces users to view articles and posts that differ from their political beliefs. A user must go through these steps to get started with NewViewsNews: +1. Create an account. In addition to creating an account, you can also login using an already existing Google, Github, or Facebook account. +2. Take the political compass quiz. The results of this quiz (provided by Spekr) will allow us to determine your position on the political compass. We use this data to determine which articles will show up on your home page. +3. Now you can view articles or write your own! + +NewViewsNews also includes other features: +- Liking other's posts +- Providing other news articles from outside news sources sorted by political alignment +- Allowing numerous customization options for writing articles +- Allowing you to tag each article you write with the article's political alignment +- Allowing you to view your position on the political spectrum + +## How we built it + +The web app (frontend and backend) rests on a Django framework with a postgresql database. We built it with Django, and a basic web stack (HTML, CSS, JS). The website is also hosted on Rushil's home server, at [newviewsnews.crucialnet.org](newviewsnews.crucialnet.org), and we all collaborated through GitHub [repo](github.com/rushilwiz/newviewsnews.git). The website consists of two main models other than the main User, which was the user profile and each article. + +## Challenges we ran into +A lot of us did not have the knowledge to keep up with some of our team members, resulting in an uneven workload distribution as far as web development. This resulted in a lot of teamwork challenges, such as our progress being bottlenecked based on the presence of certain members. Also, some of us were relatively new to Git, which resulted in a learning curve and some confusion at times. + +## Accomplishments that we're proud of +1. Making a website from scratch +2. Learning about Django and various aspects of web development +3. Learned/improved our skills in Python, CSS, HTML +4. Becoming more familiar with Git +5. Learned how to implement a RSS feed into a website + +## What we learned +We learned a lot about web development and how Django works, as well as gained experience working with Git. + +## What's next for NewViewsNews +In the future, NewViewsNews intends to integrate some of the widely popular textual analysis machine learning algorithms in order to determine not only the general mood of the article but a better sense of the underlying message one may be trying to convey. From 381a1c98928ddcbe5fa2ae2b42da83b4a61c8c87 Mon Sep 17 00:00:00 2001 From: Rushil Umaretiya Date: Sun, 16 Aug 2020 12:40:55 -0400 Subject: [PATCH 2/4] added replication instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 0cad6a4..1195cd7 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,16 @@ HackDefy submission 2020 ![GitHub](https://img.shields.io/github/license/rushilwiz/newviewsnews?color=9EC1CF) ![GitHub last commit](https://img.shields.io/github/last-commit/rushilwiz/newviewsnews?color=CC99C9) +## For the judges + +To replicate this locally just follow the following steps: + +1. Clone the repository +2. Install python 3+ +3. run ```pip install -r requirements.txt``` inside of the repository +4. run ```python3 manage.py runserver``` +5. Open localhost:8000 in the browser of your choice! + ## Inspiration Our project was inspired by the evergrowing activism community in our country that becoming is more and more toxic every year due to closemindedness and echo chambers. This has resulted in a society that has more conflict and is less understanding of people with different opinions and political viewpoints. From 1f9cc2deaaf5570a7e9b94fa346a89c1ae6e8910 Mon Sep 17 00:00:00 2001 From: Rushil Umaretiya Date: Tue, 18 Aug 2020 14:51:20 -0400 Subject: [PATCH 3/4] Create django.yml --- .github/workflows/django.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/django.yml diff --git a/.github/workflows/django.yml b/.github/workflows/django.yml new file mode 100644 index 0000000..a36d809 --- /dev/null +++ b/.github/workflows/django.yml @@ -0,0 +1,30 @@ +name: Django CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + max-parallel: 4 + matrix: + python-version: [3.6, 3.7, 3.8] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Run Tests + run: | + python manage.py test From cc081f7bbf16811882acea3316c5c8a325107530 Mon Sep 17 00:00:00 2001 From: Rushil Umaretiya Date: Tue, 25 Aug 2020 18:18:07 -0400 Subject: [PATCH 4/4] Update README.md --- README.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/README.md b/README.md index 1195cd7..42c6bef 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # NewViewsNews -HackDefy submission 2020 - +Created by: Rushil Umaretiya, Christopher Arraya, Joshua Lim, and Zaeem Qureshi ![GitHub language](https://img.shields.io/github/languages/top/rushilwiz/newviewsnews?color=FF6663) @@ -10,16 +9,6 @@ HackDefy submission 2020 ![GitHub](https://img.shields.io/github/license/rushilwiz/newviewsnews?color=9EC1CF) ![GitHub last commit](https://img.shields.io/github/last-commit/rushilwiz/newviewsnews?color=CC99C9) -## For the judges - -To replicate this locally just follow the following steps: - -1. Clone the repository -2. Install python 3+ -3. run ```pip install -r requirements.txt``` inside of the repository -4. run ```python3 manage.py runserver``` -5. Open localhost:8000 in the browser of your choice! - ## Inspiration Our project was inspired by the evergrowing activism community in our country that becoming is more and more toxic every year due to closemindedness and echo chambers. This has resulted in a society that has more conflict and is less understanding of people with different opinions and political viewpoints.