divyansh-2005 / FinNews

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.
https://fin-news-one.vercel.app/
20 stars 73 forks source link
gssoc-ext hacktoberfest hacktoberfest-accepted

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

Technologies Used

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

Happy coding!