Karla Gaudet - She Codes News Project

About This Project

Our brief was to create a news website for She Codes Australia that allows users to read news stories, and authors to create them.

How To Run This Code

1. Clone the repo to your local machine - Navigate to the directory of your choice and run the following command:

   • git clone [https://github.com/ktechgau/she_codes_news]

2. Set up Virtual Environment - In your terminal, navigate to the folder containing requirements.txt file:

   • Mac run the following command: source ./venv/bin/activate
   • Windows run the following command: venv/Scripts/activate

3. Install Django, Migrate, Load Data and Run:

   • python3 -m pip install -r requirements.txt
   • python3 -m pip freeze (to check if install successful)
   • cd she_codes_news (to navigate to where manage.py file is contained)
   • python3 manage.py migrate to make migrations
   • python3 manage.py loaddata news (to load the data for the articles)
   • python3 manage.py runserver (to run the server)

4. View the She Codes News site: http://localhost:8000/news

Databse Schema

Features

View Features Video (Youtube Channel)

Compulsory Features:

• Order the stories by date

• Style the form for adding new stories.

• Add a field to the NewsStory model for an image url and use this image url rather than the default images provided in the starter

• Show/Hide relevant information/buttons on whether the user is logged in/out

• Enable/Disable relevant features based on whether the user is logged in/out

Facilitated Feature: Creating a Users app:

• Functional login/logout buttons
• Account view so authors can see their profile information
• Create Account functionality, so a new user can sign up to be an author
• View stories by a particular author

Additional Features implemented:

• Ability to update and delete stories (permissions considered)
• Time set of story published instead of just the date
• Ability to comment on stories
• User Profiles include stories they have written, ability to update and delete profile details

Future Developments:

Here are some features yet to be implemented:

• "Delete" function for user accounts
• Search/filter by story categories
• "Likes" function
• Keyword Search