Skip to content

correct setup and installation steps in README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DORMODO wants to merge 1 commit into
base: main
Choose a base branch
from
Open

correct setup and installation steps in README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,25 @@
News feed App built using React, Material UI & NewsAPI

# Setup
```
npm install
```

# Run local server
```
npm run dev
```
1. **Clone the repository:**
```sh
git clone https://github.com/almdrasa/react-newsfeed_app.git
cd news-feed-app
```

2. **Install dependencies:**
```sh
npm install
```

3. **Set up environment variables:**
- Create a `.env` file in the root directory.
- Add your News API key:
```
VITE_NEWS_API_KEY=your_api_key_here
```

4. **Run the app:**
```sh
npm run dev
```