rohan-cod/newspaper-app

A web app using the Django framework. Frontend using HTML, CSS, javascript, and bootstrap. Add articles that can be viewed by anyone. Just make an account and you are good to go.

Newspaper App

A web app made using the django framework. Frontend using html and bootstrap and sqlite3 is used as the database. You can add articles which can be viewed by anyone. Just make an account and you are good to go.

Requirements

Python 3.8
Django 2.2.10 And additional requirements are in Pipfile.

Setting up the Project

• Download and install Python 3.8
• Download and install Git.
• Fork the Repository.
• Clone the repository to your local machine $ git clone https://github.com/<your-github-username>/newspaper-app.git
• Change directory to newspaper-app $ cd newspaper-app
• Install pipenv $ pip3 install pipenv
• Create a virtual environment and install all requirements from Pipfile $ pipenv install
• Activate the env: $ pipenv shell
• Make migrations $ python manage.py makemigrations
• Migrate the changes to the database $ python manage.py migrate
• Create superuser $ python manage.py createsuperuser
• Run the server $ python manage.py runserver

Deployment

Here's a list of steps to be followed for deploying an app to heroku:

• Run pipenv lock to generate the appropriate Pipfile.lock $ pipenv lock
• Then create a Procfile which tells Heroku how to run the remote server where our code will live. $ touch Procfile
• For now we’re telling Heroku to use gunicorn as our production server and look in our .wsgi file for further instructions. Update Procfile with - web: gunicorn <project_name>.wsgi --log-file -
• Next install gunicorn which we’ll use in production while still using Django’s internal server for local development use. $ pipenv install gunicorn==19.9.0
• Finally update ALLOWED_HOSTS with '*' in settings.py file.
• push the updates to the GitHub repository.
• Login to heroku. $ heroku login
• Create a new heroku app. $ heroku create <app_name>
• Set git to use the name of your new app when you push to Heroku. $ heroku git:remote -a <app_name>
• If there are no static files run $ heroku config:set DISABLE_COLLECTSTATIC=1
• Push the code to Heroku. $ git push heroku master
• Add free scaling so the app is actually running online. $ heroku ps:scale web=1

Contributing

Feel free to raise a issue or make a pull request to fix a bug or add a new feature. If you are new to open source you can first read about git by clicking here.

Communtiy Slack Channel

To get started, the first step is to meet the community. We use slack to communicate, and there the helpful community will guide you. Slack is an instant messaging service used by developers and users of GitHub. It uses chatrooms, where developers can join in and can talk about a particular topic. Click here to join our Slack Workspace.

Code Of Conduct

Check the code of conduct.

newspaper-app's Issues

Add search bar.

Add a search bar to search for different articles posted on the website.

Classify articles.

Use machine learning to classify the articles into positive and negative.

Add change password functionality

To make the change password functionable .Templates have been built ,we have to make the functionality workable.

Adding navbar in profile page (frontend).

Implementing navbar of the profile page (frontend) and making user profile more interactive.

Add back to top button

Add a back to top button. Use an elegant symbol for the button.

Profile Page

Add user profile page with details about user like the profile pic, name, e-mail, etc.

Latest News.

Use an api to get latest news and show them in a separate tab in the app.

Scroll bar for comments

Add a scroll bar for comments which are displayed on the all articles page.

Different link for article's comments.

Currently the comments link on every article's footer points to a single page with comments of all articles. Change this in such a way so that each link points to its own comments only.

Search

Recreate the search bar in such a way that its on the nav bar and users can search articles no matter which page they are on.

Add readme

Study the source code and make a readme for the project.

May need to run this command to get all packages

python3 -m pip install requirements.txt

Enhancing the navbar

I have created a profile page and in that I have to enhance the navbar of the user profile page.

Add a sort option.

Add an option on articles page to sort articles according to different parameters possible.

option for comment from articles page

Add an option to add comment to an article directly from the articles page. The model for comment is already built, just add a link to add comment.

Improve email verification.

Voice Input

Add a button for Voice Input like google has for google assistant.

Application error

Application error on heroku. Exiting with status 1.

email to reset password.

Add email facility to reset password. The reset password facility is available. The link to reset the password is generated as soon as you press the reset password link. You just need to use the api that will send that link to the user.

Friends

Add a feature wherein user can send friend requests and a user can only see articles written by his friends.

Compatibility between different packages

Check the compatibility between different packages in pipfile. Some of the packages might not compatible with the used version of django.

Image not displaying.

After uploading and saving the image doesn't show up on the article_details page.

Image cropping option.

Add functionality to crop image either while uploading or after uploaded.

Improve the README.md file.

Make the documentation more informative and descriptive.

facing error while setting up the project

Hi, I am facing some errors while setting up the project locally.

It says: Failed creating virtual environment

Improve the UI

Use html, css and javascript to improve the UI of the app.