Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alisat81/news-app
This project is a news application that fetches cryptocurrency news from the New York Times API, allowing users to view, bookmark, edit, and delete articles. It utilizes Redux for state management, with local storage used to persist bookmarks, edited, and deleted news items.
https://github.com/alisat81/news-app
axios joy-ui localstorage react reactjs redux-toolkit vite
Last synced: 26 days ago
JSON representation
This project is a news application that fetches cryptocurrency news from the New York Times API, allowing users to view, bookmark, edit, and delete articles. It utilizes Redux for state management, with local storage used to persist bookmarks, edited, and deleted news items.
- Host: GitHub
- URL: https://github.com/alisat81/news-app
- Owner: AliSat81
- License: mit
- Created: 2024-11-12T03:21:23.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T03:49:11.000Z (3 months ago)
- Last Synced: 2024-11-12T04:24:44.910Z (3 months ago)
- Topics: axios, joy-ui, localstorage, react, reactjs, redux-toolkit, vite
- Language: JavaScript
- Homepage: https://news-app-iota-pied.vercel.app
- Size: 327 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crypto News App
A React-based news app designed to fetch and display the latest crypto news from the New York Times API. The app allows users to bookmark, edit, and delete news articles. It integrates Redux for state management and localStorage for persistent data storage.
## Features
- **Fetch Crypto News**: Fetch the latest news articles related to cryptocurrency using the New York Times API.
- **Bookmark**: Save articles to a bookmark list, stored both in Redux and localStorage.
- **Edit**: Update the details of a bookmarked article, with changes saved in Redux and localStorage.
- **Delete**: Remove articles from the news feed, bookmarks, and selected news, with updates stored persistently.
- **Persistent Data**: Store bookmarks, edited news, and deleted news in localStorage, ensuring data persists across page reloads.
- **State Management**: Use Redux Toolkit for managing application state efficiently, including fetching news, bookmarking, editing, and deleting articles.
## Technologies Used
- **React**: A JavaScript library for building user interfaces.
- **Redux Toolkit**: A modern approach to managing state in React applications.
- **Axios**: A promise-based HTTP client for making API requests.
- **New York Times API**: Provides access to a vast collection of news articles.
- **localStorage**: To persist bookmarks, edited items, and deleted items.
- **Material UI (Joy UI)**: A React component library for building modern UIs.
## Installation
### Prerequisites
Make sure you have the following installed:
- [Node.js](https://nodejs.org/) (version 16 or later)
- [npm](https://npmjs.com/) (version 8 or later)
### Steps
1. **Clone the repository**:
```bash
git clone https://github.com/your-username/news-app.git
```
2. **Navigate to the project directory**:
```bash
cd news-app
```
3. **Install dependencies**:
```bash
npm install
```
4. **Set up your environment variables**:
Create a `.env` file in the project root and add your New York Times API key:
```plaintext
VITE_NYT_API_KEY=your_nyt_api_key
```
### Running the Application
To start the application in development mode:
```bash
npm run dev
```