https://github.com/rh9891/newyorktimesarticlesearch
An application that utilizes the New York Times Article API to pull historic articles based on search parameters.
https://github.com/rh9891/newyorktimesarticlesearch
ajax bootstrap css html javascript jquery newyorktimessearch-api
Last synced: about 1 year ago
JSON representation
An application that utilizes the New York Times Article API to pull historic articles based on search parameters.
- Host: GitHub
- URL: https://github.com/rh9891/newyorktimesarticlesearch
- Owner: rh9891
- Created: 2020-06-17T00:27:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-26T13:53:02.000Z (over 5 years ago)
- Last Synced: 2023-09-24T17:38:31.739Z (over 2 years ago)
- Topics: ajax, bootstrap, css, html, javascript, jquery, newyorktimessearch-api
- Language: JavaScript
- Homepage: https://rh9891.github.io/NewYorkTimesArticleSearch/
- Size: 12.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# New York Times Article Search
[](https://opensource.org/licenses/MIT)
## Table of Contents
* [Description](#description)
* [User Story](#user-story)
* [Features of the Application](#features-of-the-application)
* [Preview of New York Times Article Search](#preview-of-new-york-times-article-search)
* [Links](#links)
* [Usage](#usage)
* [Built Using](#built-using)
* [License](#license)
* [Questions](#questions)
## Description
Server-side APIs are an interface often used by companies to allow users a way to interact and gain access to their information. For this article search application, I used the [New York Times Article Search API](https://developer.nytimes.com/docs/articlesearch-product/1/overview) in order to retrieve data to access articles based on the user's search parameters.
The retrieved data from the New York Times Article Search API call - based on a user search term - provided the headline, byline, author, publication date and year, among other details. Using this information, I was able to sift through the JSON object, extract the relevant information to render onto the bottom of the page, and build an application - that is both dynamic and functional - that retrieves a sought number of records for the user.
## User Story
~~~
AS A user
I WANT to search the New York Times database for articles using specific parameters
SO THAT I can retrieve a list of articles to read.
~~~
## Features of the Application
~~~
GIVEN a New York Times article search application with form inputs
WHEN I search for a term
THEN I am presented with relevant articles that include the search term.
WHEN I use the search parameters, such as its start year and its end year,
THEN I am presented with relevant articles that adhere to the search parameters.
~~~
## Preview of New York Times Article Search
The following images demonstrate the application functionality:
The following GIF demonstrates the application functionality, showcasing the application's ability to clear results and specify the number of records to retrieve:
## Links
1. [Deployed Application](https://rh9891.github.io/NewYorkTimesArticleSearch/)
2. [Github Repository](https://github.com/rh9891/NewYorkTimesArticleSearch)
## Usage
The following example of usage displays the use of the ajax call to the New York Times Article Search API to retrieve the JSON object:
~~~
var queryURL = buildQueryURL();
$.ajax({
url: queryURL,
method: "GET"
}).then(updatePage);
~~~
## Built Using
Listed below are the frameworks and guides that made building this article search application possible.:
* [Bulma](https://bulma.io/)
* [JQuery](https://jquery.com)
* [New York Times API Documentation](https://developer.nytimes.com/docs/articlesearch-product/1/overview)
## License
The MIT License (MIT)
Copyright (c) 2020 Romie Hecdivert
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## Questions
If you have any questions, comments, or issues regarding this New York Times article search application, please don't hesitate to contact me via [Github](https://github.com/rh9891).