https://github.com/oshkoshbagoshh/python-newsfeed-2

https://github.com/oshkoshbagoshh/python-newsfeed-2

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/oshkoshbagoshh/python-newsfeed-2
• Owner: oshkoshbagoshh
• Created: 2023-10-25T19:28:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-12T23:59:49.000Z (10 months ago)
• Last Synced: 2024-10-16T19:41:02.261Z (2 months ago)
• Language: Python
• Size: 252 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# python-newsfeed-2

## Description

- The goal of this project is to create a newsfeed application that allows users to post and view news articles. The application will be built using Python and Flask. The application will be deployed to Heroku.

- The motivation for this project is to learn how to build a full-stack application using Python and Flask.

- This project solves the problem of not having a newsfeed application that allows users to post and view news articles.

## Table of Contents (Optional)

If your README is long, add a table of contents to make it easy for users to find what they need.

- [python-newsfeed-2](#python-newsfeed-2)

  - [Description](#description)

  - [Table of Contents (Optional)](#table-of-contents-optional)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Credits](#credits)

  - [License](#license)

  - [Features](#features)

  - [How to Contribute](#how-to-contribute)

  - [Tests](#tests)

## Installation

To install this project, clone the repository and run the following commands in the terminal:

```sh

pip install -r requirements.txt

```

## Usage

![Alt text](<300-home-preview (1).png>)

## Credits

- AJ Javadi 

- Northwestern EDX Bootcamp

## License

* MIT License

---

## Features

- CRUD functionality(Users can create, read, update, and delete posts)

- signup, login, and logout functionality

- password hashing

- user authentication

- user authorization

- user sessions

  

## How to Contribute

- My next goal for the project is to add a feature that allows users to upload images to their posts.

- I would also like to encorporate the use of the faker library to generate fake users and posts.

- I would also like to add a feature that shows the highest rated posts on the home page, and a feature that allows users to rate posts.

  

## Tests

- User auth 

- User sessions

- CRUD functionality

- Password hashing

- User authorization

- User authentication

- Database deployment

- environment variables