Newzzy is a news aggregation and delivery platform that allows users to get the latest news from various sources, manage their preferences, and interact with news content in real time. The application is built with Node.js, Express.js, MongoDB, and integrates with the News API.
- Aggregates news from multiple sources using NewsAPI.
- User authentication and JWT-based authorization.
- User preferences and profile management.
- Dynamic and real-time news updates.
- RESTful API endpoints for all major operations.
- MongoDB for scalable data storage.
- Node.js (v14 or higher)
- MongoDB (You can use MongoDB Atlas)
- NewsAPI Key
-
Clone the repository:
git clone https://github.com/0Ankit0-0/Newzzy.git cd Newzzy -
Install dependencies:
npm install
-
Set up environment variables:
Create a
.envfile in the root directory and add the following:NEWS_API_KEY=your_news_api_key MONGO_URI=your_mongo_connection_string PORT=5001 JWT_SECRET=your_jwt_secretImportant: Never share your actual API keys, MongoDB URI, or JWT secrets publicly. The values provided in this README are examples only.
-
Start the server:
npm start
The server will run on
http://localhost:5001by default.
POST /api/auth/register– Register a new userPOST /api/auth/login– User loginGET /api/news– Get latest newsGET /api/user/profile– Get user profile (authentication required)- ...and more
Consult the source code or API documentation for detailed usage.
Newzzy/
├── controllers/
├── models/
├── routes/
├── utils/
├── .env.example
├── server.js
└── README.md
##Website Link
Newzzy is a news aggregation and delivery platform...
Do not commit sensitive information like API keys, database URIs, or JWT secrets to public repositories. Always use environment variables and .env files, and add .env to your .gitignore.
This project is licensed under the MIT License.
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
Disclaimer: This project uses third-party APIs and services. Please comply with their terms of service.
