https://github.com/jt2m0l3y/news-aggregator

Web app for saving articles needed later, developed as an individual final project for courses in both Web Development and Database Management.
https://github.com/jt2m0l3y/news-aggregator

css dbms expressjs full-stack html javascript jquery-ajax mysql nodejs npm web-development

Last synced: about 2 months ago
JSON representation

Web app for saving articles needed later, developed as an individual final project for courses in both Web Development and Database Management.

• Host: GitHub
• URL: https://github.com/jt2m0l3y/news-aggregator
• Owner: JT2M0L3Y
• Created: 2023-05-25T12:12:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-03T20:36:00.000Z (8 months ago)
• Last Synced: 2024-05-03T21:46:51.476Z (8 months ago)
• Topics: css, dbms, expressjs, full-stack, html, javascript, jquery-ajax, mysql, nodejs, npm, web-development
• Language: JavaScript
• Homepage:
• Size: 171 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README



## News Compilation Website



### Description

This project is a website that allows members to filter a news feed to only see content from sources and topics they want to see. 

The goal here is to reduce online surfing time for web visitors to find what news they want to see.

As my first attempt at full-stack development, this new compilation web app should demonstrate my abilities with common tools and practices at the end of 2022.



### Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)



### Installation

To run this web app, one must initialize a NodeJS environment.  

Within this environment there are a few packages that are required:

* express

* express-session

* ejs

* mysql

* mysql-validator

This project uses a MySQL database. As such, I have included a pair of SQL scripts to be used in populating a MySQL database. The host server I use to access this database is Gonzaga's dedicated MySQL server.

To configure one's database connection, a config.json file is required that contains:

```

{

    "host": "desired server",

    "user": "your username",

    "password": "your password",

    "database": "your database"

}

```

Also, I have included my API key to the news API I used. This key allows for 200 requests per day. Because the articles cannot yet be queried from the database, I have kept the API call for the present deliverable.



### Usage

Features:

- register/delete account to track saved articles

- login/logout to access saved articles

- search articles (currently only articles from the API)

- click to read more about an article

![articles_page](https://user-images.githubusercontent.com/67881240/205704385-fa568ff7-21ac-4cc0-bfbc-290696f67772.png)



### Contributing

I currently have no expectations that others will contribute to this project.



### Credits

Contributors: 

- JT2M0L3Y



### License

No license needed at this stage of development.

[GitHub’s licensing guide](https://choosealicense.com/)