AgbajeOlayiwola / NYTimesApp

New York Times Top Stories Using NYTimes API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This project was bootstrapped with Create React App.

CircleCI Maintainability Test Coverage

NYTimes App

A simple Web-App utilizing the NY Times API most viewed section. Built for Mobile.



nytimes-app-screenshot           nytimes-app-screenshot

Table of Contents

Getting Started

This is a javascript application built with React libary on the nodejs platform.

Technology Stack

UI & Templates

  1. HTML, SCSS, CSS
  2. Bootstrap 4 CSS Framework
  3. Reactstrap
  4. Javascript(React)

Dependencies

  • Node

Installation

  1. Install Node JS.

  2. To Clone the Run npm clone https://github.com/kevinejiro/nytimes-app.git

  3. [cd] into the root of the project directory.

  4. Run npm install on the terminal to install Dependecies

  5. Start the application: Different Build Environment

Run Development Build

npm run start:dev

Run Production Build

npm run build
npm run start

Usage

  • Start app development with npm run start or npm start

Testing

To tests - Run npm run test on the terminal while within the project root directory.

Testing is achieved through the use of jest package. jest is used to test javascript code in React applications.

Questions

For more details contact kevinejiro@gmail.com

Support or Contribution

For any suggestions or contributions please do not hesistate to contact me

Contributions to this project are welcomed by all, If you need to contribute to this project, follow the steps below

  • Fork the repository
  • Follow Installation and Setup as explained earlier
  • Create a branch off development for the feature you wish to add
  • Make neccessary changes, commit and raise a pull request against develop. Note when making contributions, please endevour to follow the Airbnb javascript style guide.

License

This project is authored by Ejiro Ogidigbo (kevinejiro@gmail.com) and is licensed for your use, modification and distribution under the MIT license. MIT © ejiro-ogidigbo

About

New York Times Top Stories Using NYTimes API


Languages

Language:JavaScript 80.3%Language:SCSS 13.9%Language:CSS 3.3%Language:HTML 2.5%