Skip to content

shadmanshaikh/TodaysNewz

Repository files navigation

todaysnewz

Today's News Site

Today's News Site is a web application that provides users with the latest news articles. It is built using the MERN (MongoDB, Express.js, React.js, Node.js) stack.

Features

  • View the latest news articles.
  • Search for specific topics or keywords.
  • Read full articles with detailed information.
  • Bookmark articles for later reading.

Technologies Used

  • MongoDB: NoSQL database for storing news articles and user data.
  • Express.js: Web application framework for Node.js used for handling server-side logic.
  • React.js: JavaScript library for building user interfaces.
  • Node.js: JavaScript runtime for server-side development.
  • Axios: Promise-based HTTP client for making requests to the server.
  • Material-UI: React components for building a modern and responsive UI.
  • Mongoose: MongoDB object modeling for Node.js.
  • Redux: State management library for React applications.

Getting Started

Prerequisites

  • Node.js and npm installed.
  • MongoDB installed and running.

Installation

  1. Clone the repository: git clone https://github.com/yourusername/todays-news-site.git
  2. Navigate to the project directory: cd todays-news-site
  3. Install server dependencies: cd server && npm install
  4. Install client dependencies: cd ../client && npm install

Configuration

  1. Create a .env file in the server directory with the following content:

  2. Replace your_mongodb_connection_string with your actual MongoDB connection string.

Running the Application

  1. Start the server: cd server && npm start
  2. Start the client: cd ../client && npm start
  3. Open your browser and visit http://localhost:3000 to view the application.

API Reference

The API reference for the server-side endpoints can be found in the API.md file.

Contributing

If you would like to contribute to the project, please follow the contribution guidelines.

License

This project is licensed under the MIT License.

Feel free to contribute, report issues, or provide feedback!