https://github.com/karan-develops/newzly
A news app built on Next Js, having backend and frontend separate. It has cron-job enabled to fetch news and store it in database.
https://github.com/karan-develops/newzly
express-js nextjs vercel
Last synced: 5 months ago
JSON representation
A news app built on Next Js, having backend and frontend separate. It has cron-job enabled to fetch news and store it in database.
- Host: GitHub
- URL: https://github.com/karan-develops/newzly
- Owner: Karan-develops
- License: mit
- Created: 2025-01-08T16:13:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-08T18:02:59.000Z (over 1 year ago)
- Last Synced: 2025-06-23T13:52:10.806Z (about 1 year ago)
- Topics: express-js, nextjs, vercel
- Language: TypeScript
- Homepage: https://newzly-karan.vercel.app
- Size: 2.98 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔰 Newzly
- A news app having built on Next Js, having backend and frontend separate. It has cron-job enabled to fetch news and store it in database.
- Backend deployed on `render.com` and [frontend](https://newzly-karan.vercel.app/) on `vercel` under free tier.
## 📚 Tech Stack
- **Client:** Next JS, TailwindCSS
- **Server:** Node, Express
- **Datebase:** Mongo DB
## 📦 API Reference, Routes & Misc
| Route | Type | Protected | Parameter | Description |
| :------------------------- | :------- | :-------- | :-------------------------------------------------------------------------------------------------- | :------------------------------------------------ |
| `/api/services/send-email` | `POST` | No | `toName`, `toEmail`, `subject`, `message` (all body) | Used to send mails |
| `/api/data/get-news` | `GET` | No | `category`, `country`, `page`, `limit` (all query) | Used to fetch news |
| `/api/data/store-news` | `POST` | Yes | `headline`, `description`, `category`, `country`, `publisher`, `image_link`, `news_link` (all body) | Push news to database fetched by `update-data.js` |
| `api/data/delete-news` | `DELETE` | Yes | `None` | Delete news every 24 hour (5 items) |
- This project also has a `cron-job` which runs every `20 minutes` to add new data to database. This may be commmented while on development mode (suggested).
- Also a `cron-job` to delete database items is scheduled and run `once every day` to delete 5 items from database. This may be also commmented while on development mode (suggested).
- `Vercel Analytics` is also enabled for this web app
## 🔩 Environment Variables
This project requirement .env configuration in `Backend` as well in `Frontend` folder.
### Backend
| Varibale | Description |
| :--------------- | :---------------------------------------------- |
| `MONGODB_URI` | Database URI |
| `PORT` | Port number for backend (5000) |
| `EMAIL` | admin mail address |
| `PASSWORD` | App password of email account |
| `G_NEWS_API_KEY` | G News API key |
| `AUTH_KEY` | Auth key to secure routes |
| `HASHED_KEY` | Double SHA-256 Hashed Auth key to secure routes |
### Frontend
| Varibale | Description |
| :--------- | :---------- |
| `SITE_URL` | Site URL |
## 🔨 Setting Up
Follow the following instruction to setup the project and run locally
- Replace the backend URI to `http://localhost:5000` from `https://newzly.onrender.com`
- Make sure, the environemental variables are set.
- Open two seperate terminals and run `npm install` and then `npm run dev` in both terminals, one for backend and one for frontend. `package.json` is configured in a way it will start the dev mode by running `npm run dev`.
- Hurray! your app will be started in development mode.
## ⚡ Features
- `Various News Types Supported:` World, General, Nation, Business, Technology, Entertainment, Sports, Science, Health.
- `Wide Range of Countries Supported:` India, Brazil, Canada, France, Japan, United States
## 📁 File Structure :
```
Directory structure:
└── Karan-develops-Newzly/
├── Backend/
│ ├── index.js
│ ├── package-lock.json
│ ├── package.json
│ ├── .gitignore
│ ├── config/
│ │ └── db.js
│ ├── controllers/
│ │ ├── data.controller.js
│ │ └── email.controller.js
│ ├── middlewares/
│ │ └── protectRoute.js
│ ├── models/
│ │ └── news.model.js
│ ├── routes/
│ │ ├── data.route.js
│ │ └── email.route.js
│ └── scripts/
│ ├── delete-data.js
│ └── update-data.js
└── frontend/
├── README.md
├── eslint.config.mjs
├── next.config.ts
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── tailwind.config.ts
├── tsconfig.json
├── .gitignore
├── app/
│ ├── error.tsx
│ ├── globals.css
│ ├── layout.tsx
│ ├── page.tsx
│ ├── hooks/
│ │ └── useInfiniteScroll.ts
│ ├── lib/
│ │ └── definition.ts
│ └── ui/
│ ├── loaders.tsx
│ ├── components/
│ │ └── NewsCard.tsx
│ └── landing/
│ ├── Footer.tsx
│ ├── Hero.tsx
│ ├── Navbar.tsx
│ └── News.tsx
└── public/
├── assets/
└── fonts/
├── Degunfa.ttf
├── Dosis.ttf
├── Galebok.otf
├── Odin.otf
├── RIntjany.ttf
└── youmurdererbb.ttf
```
## 🔥 Contributing
Contributions are always welcome! Additionally you can contact me by my email: **mrkaran2k5@gmail.com**. Some features which are developmemt and contributions can be made are:
- [ ] Support for different languages.
- [ ] Support for narration of news.
- [ ] Support to save favourite news of user
- [ ] AI chatbot for user interaction
## 📷 Screenshots
## 🔒 License
This repository is open source and under [MIT](https://choosealicense.com/licenses/mit/) License.