krupalpatel92 / news-aggregator-app Goto Github PK

News Aggregator web site: PHP + Laravel + ReactJS

Frontend Tech:- ReactJS, TypeScript, ReactQuery by TanStack https://tanstack.com/query/v3/

Backend Tech:- PHP, Laravel, MySQL

Feature

1. Signup / Signin
2. Personalized Feed recommendation
3. Save the Search result
4. Search & Filter by text, category, author, and source
5. Social SignIn (ToDo)
6. Bookmark Search Result (ToDo)
7. Social Share (ToDo)
8. Comments & Discussion thread (ToDo)
9. Provide User Independent News Feeder. So, the user can add multiple news feed sources as needed. (ToDo)
10. Mobile APP using ReactJS + CapacitorJS (ToDo)

News Feed Source From

• NewAPI.org - https://newsapi.org
• The Guardian - https://www.theguardian.com
• New York Time - https://nytimes.com

Follow these commands to setup and run the frontend project.

First run nvm use command set NodeJS version this project required.

Needs to execute before all git add/commit to fix Linting, TS, and SCSS issue and formatting. All below command will be executed when run fix:preBuild

• yarn fix:style
• yarn fix:lint
• yarn fix:esLint

Update const API_BASE_URL under src/api/endpoints.ts (NOTE: As of now static. Needs to be in ENV)

Follow all these steps to setup the backend

1. composer install
2. php artisan migrate
3. php artisan db:seed
4. php artisan passport:install
5. php artisan serve will run API server on url http://127.0.0.1:8000

1. Import API-document.postman_collection.json into Postman (https://www.postman.com)
2. Setup variable {{baseUrl}} with backend URL http://127.0.0.1:8000
3. Setup variable {{accessToken}} and store signIn access_token to use it in protected APIs. Like preferences endpoint.
4. To insert news feed in DB. Execute the API in Postman collection Sync Feed > Get Latest News Feed. Read its documentation and params description carefully.