Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c-mohammed-zaid/news-app
The News App is a user-friendly platform that allows users to read daily news and create their own articles, designed for beginners to learn web development with modern technologies.
https://github.com/c-mohammed-zaid/news-app
bootstrap css express html javascript mongodb nodejs react
Last synced: 7 days ago
JSON representation
The News App is a user-friendly platform that allows users to read daily news and create their own articles, designed for beginners to learn web development with modern technologies.
- Host: GitHub
- URL: https://github.com/c-mohammed-zaid/news-app
- Owner: C-MOHAMMED-ZAID
- Created: 2024-08-06T16:52:29.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-08T04:35:29.000Z (3 months ago)
- Last Synced: 2024-08-20T14:26:53.044Z (3 months ago)
- Topics: bootstrap, css, express, html, javascript, mongodb, nodejs, react
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Certainly! Here’s a detailed and precise README file for your News App GitHub repository. This README is structured to provide clear information about your project, its features, and how others can contribute.
```markdown
# News App
Welcome to the **News App**! This is a beginner-friendly project that allows users to read daily news and create their own news articles. Built with modern web technologies, this app serves as an excellent resource for learning how to connect a frontend with a backend database.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Daily News**: Read the latest news articles from various categories.
- **Create News**: Users can create and submit their own news articles.
- **User-Friendly Interface**: Simple and intuitive design for easy navigation.
- **Responsive Design**: Works seamlessly on both desktop and mobile devices.
## Technologies Used
- **Frontend**:
- HTML
- CSS
- JavaScript
- React
- **Backend**:
- Node.js
- Express.js
- MongoDB
## Getting Started
To get a local copy of this project up and running, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/c-mohammed-zaid/news-app.git
```
2. **Navigate to the project directory**:
```bash
cd news-app
```
3. **Install frontend dependencies**:
Navigate to the frontend directory and install the required packages:
```bash
cd frontend
npm install
```
4. **Install backend dependencies**:
Navigate to the backend directory and install the required packages:
```bash
cd ../backend
npm install
```
5. **Set up the MongoDB database**:
- Create a MongoDB database and update the connection string in the backend configuration file.
6. **Run the application**:
- Start the backend server:
```bash
node index.js
```
- Start the frontend application:
```bash
cd ../frontend
npm start
```
Your application should now be running on `http://localhost:3000`.
## Usage
- Visit the homepage to view the latest news articles.
- Click on the "Create News" button to submit your own articles.
- Explore different categories to find news that interests you.
## Contributing
Contributions are welcome! If you want to help improve this project, please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeatureName
```
3. Make your changes and commit them:
```bash
git commit -m "Add your feature description"
```
4. Push to the branch:
```bash
git push origin feature/YourFeatureName
```
5. Open a pull request.
Feel free to suggest new features, report bugs, or improve the documentation!
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
---
Thank you for checking out the News App! Happy coding!
```