An open API service indexing awesome lists of open source software.

https://github.com/samya-s/newsmonkey

NewsMonkey is a news app which can be used to grab quick daily news bites, made using React framework.
https://github.com/samya-s/newsmonkey

bootstrap latest-news news newsapi newsmonkey react reactjs

Last synced: about 2 months ago
JSON representation

NewsMonkey is a news app which can be used to grab quick daily news bites, made using React framework.

Awesome Lists containing this project

README

        

# NewsMonkey

NewsMonkey is a news app which can be used to grab quick daily news bites. If you are interested in news, weather, politics and sports news, NewsMonkey is for you!

>Please Note: This app uses NewsAPI from [newsapi.org](https://newsapi.org/) to fetch news. Currently newsapi.org supports free API calls only from development server (i.e. localhost) and hence this app is not hosted anywhere else.

This project was made with [Create React App](https://github.com/facebook/create-react-app) using React framework.

Earlier version of this app uses react `class based components` - [Go to class based version](https://github.com/Samya-S/NewsMonkey/tree/eb13c6f504d9923266aacadf7fa841bc046d857e).
Current version of this app uses react `function based components`.

## Table of Contents

- [Installation](#installation)
- [Run dev environment](#run-dev-environment)
- [Available Scripts](#available-scripts)

## Installation

1. Clone the repository:

```bash
git clone https://github.com/Samya-S/NewsMonkey.git
```
`Make sure you have SSH keys setup in your machine`

2. Navigate to the project directory:

```bash
cd NewsMonkey
```

3. Install dependencies:

```bash
npm install
```
or alternatively
```bash
npm i
```
`Make sure to have nodejs and npm installed`

## Run dev environment

Use the following command to run:

```bash
npm start
```

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)