Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pranavarora1895/react_newsmonkey
Personalized News App using React and NewsAPI
https://github.com/pranavarora1895/react_newsmonkey
Last synced: about 2 months ago
JSON representation
Personalized News App using React and NewsAPI
- Host: GitHub
- URL: https://github.com/pranavarora1895/react_newsmonkey
- Owner: pranavarora1895
- License: apache-2.0
- Created: 2022-06-07T02:49:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T01:21:29.000Z (4 months ago)
- Last Synced: 2024-08-23T02:28:52.559Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NewsMonkey
NewsMonkey is a React application that provides users with the latest news using the NewsAPI. It allows users to view and search for news articles from various sources and categories.
### Landing Page
### Specific News Page (for example, Science)
## Features
- Fetches news articles from NewsAPI
- Search functionality to find specific news topics
- Responsive design for a seamless experience on various devices
## Getting Started
Follow these instructions to set up and run the project on your local machine.
### Prerequisites
Ensure you have the following installed:
- Node.js (v14 or higher)
- npm (comes with Node.js)
### Installation
- Clone the repository
```bash
git clone https://github.com/yourusername/newsmonkey.git
```
- Navigate into the project directory
```bash
cd newsmonkey
```
- Install dependencies
```bash
npm install
```
### Configuration
You need to set up your NewsAPI key. Create a .env.local file in the root of the project and add your API key:
```env
REACT_APP_NEWS_API=your_api_key_here
```
Replace *your_api_key_here* with your actual NewsAPI key.
### Running the Application
To start the development server and run the app:
```bash
npm start
```
This command will start the development server and open the app in your default web browser. The app will be available at http://localhost:3000.
### Building for Production
To create a production-ready build of the app:
```bash
npm run build
```
The build files will be output to the build directory. You can deploy these files to your preferred hosting service.
### Running Tests
To run the tests for the application:
```bash
npm test
```
## Folder Structure
- src/ - Contains the React components and application logic
- public/ - Contains the static assets and HTML file
- .env.local - Configuration file for environment variables
## Troubleshooting
- Ensure you have the correct API key and it is set in the .env.local file.
- Check the console for any errors and refer to the NewsAPI documentation for API usage issues.
## Contributing
Feel free to open issues or submit pull requests if you have suggestions or improvements. For major changes, please open an issue first to discuss what you would like to change.
## License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.