Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 3.12 KB

README.md

File metadata and controls

93 lines (73 loc) · 3.12 KB
Raw

FinNews

Welcome to FinNews! This web application is designed to provide users with summarized financial news and insights across various categories, including finance news, government schemes, startup insights, and daily news. Built on the MERN stack (MongoDB, Express, React, Node.js), FinNews offers a seamless experience for anyone looking to stay updated on the latest in the financial world.

Features

  • Finance News: Stay informed with the latest updates and analyses in the financial sector.
  • Government Schemes: Discover government initiatives and schemes that can benefit individuals and businesses.
  • Startup Insights: Get the inside scoop on the startup ecosystem, including trends and success stories.
  • Daily News: Catch up on daily headlines and important news from various sectors.

Technologies Used

  • MongoDB: For storing and managing data.
  • Express: For building the back-end API.
  • React: For creating a responsive and interactive front-end.
  • Node.js: For running the server-side application.

Contributing

We welcome contributions! If you have suggestions for improvements or features, please fork the repo and submit a pull request.

Here’s a clear step-by-step guide for contributing to FinNews:

Steps to Contribute

  1. Fork the Repository:

    • Go to the FinNews GitHub repository.
    • Click on the "Fork" button at the top right corner of the page. This will create a copy of the repository under your GitHub account.

  2. Clone the Forked Repository:

    • Open your terminal.
    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/FinNews.git

  3. Navigate to the Project Directory:

    • Move into the repository folder: 
      cd FinNews

  4. Set Up the Project:

    • Navigate to the front-end directory: 
      cd frontend
    • Install the required dependencies: 
      npm install

  5. Start the Development Server:

    • Start the React app to see how the application works: 
      npm start

  6. Make Your Changes:

    • Create a new branch for your feature or bug fix: 
      git checkout -b your-branch-name
    • Make your changes in the code.
    • Once done, add and commit your changes: 
      git add .
git commit -m "Description of the feature/fix"

  7. Push Your Changes:

    • Push the changes to your forked repository: 
      git push origin your-branch-name

  8. Submit a Pull Request:

    • Go to your forked repository on GitHub.
    • Click on the "Compare & pull request" button.
    • Add a description of your changes and submit the pull request.

  9. Review & Merge:

    • Wait for the project maintainers to review your pull request.
    • Once approved, your changes will be merged into the main repository.

Guidelines

  • Ensure your code is well-structured and follows the project's code style.
  • Write clear commit messages.
  • Test your changes before submitting.
  • Provide detailed descriptions in your pull requests.

Happy coding!