Skip to content

Northcoders News - a social news aggregation, web content rating and discussion website. Front-End using React and linked to NC-News-BE.

Notifications You must be signed in to change notification settings

srmacpherson/NC-News-FE

Repository files navigation

NC-News

Hosted App:
https://welcome-to-nc-news.netlify.app/

Link to backend repo:
https://github.com/srmacpherson/NC-News-BE

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Node.js 16+
  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/srmacpherson/NC-News-FE.git
  2. Change directory
    cd nc-news-fe
  3. Install NPM packages
    npm install
  4. Change git remote url to avoid accidental pushes to base project
    git remote set-url origin github_username/repo_name
    git remote -v # confirm the changes

(back to top)

Usage

Northcoders News - a social news aggregation, web content rating and discussion website. Northcoders News has articles which are divided into topics, and each article has user-curated ratings from upvotes and downvotes using the API. Users can also add comments about an article.

You can navigate using the sidebar - View "ALL" articles, "TRENDING" articles or explore "TOPICS". You can also filter your results based on a number of queries. Also, you can comment and react to articles - All which will be updating the server through fast API requests.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Sam Macpherson - srmacpherson96@gmail.com

Project Link: github.com/srmacpherson/NC-News-FE

(back to top)

Acknowledgments

This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders.

(back to top)

About

Northcoders News - a social news aggregation, web content rating and discussion website. Front-End using React and linked to NC-News-BE.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published