Skip to content

Latest commit

 

History

History
67 lines (38 loc) · 1.74 KB

README.md

File metadata and controls

67 lines (38 loc) · 1.74 KB

NC News

Welcome to NC News - a social news aggregation, web content rating and discussion website. NC 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.

Deployed Version

You can access the deployed version of NC News by following this link.

Backend Repository

To explore the backend code of NC News, please visit the backend repository.

Prerequisites

Before running NC News locally, make sure you have the following minimum version of Node installed on your machine:

  • Node >= 21.6.1

You can check your Node version by running the following command in your terminal:

node --version

If you have a lower version of Node installed, please update it before proceeding.

Local Setup

To run NC News locally, follow these steps:

  1. Clone the repository using the following command:
git clone https://github.com/natccc/fe-nc-news
  1. Navigate to the project directory:
cd fe-nc-news
  1. Install the dependencies by running:
npm install
  1. Start the development server:
npm run dev
  1. Open your web browser and visit http://localhost:3000 to access the app.

Additional Configuration

[If there are any additional configuration steps required, mention them here. For example, setting up environment variables, database connections, or any other specific requirements.]

Feedback and Issues

If you encounter any issues while using NC News or have any suggestions for improvement, please open an issue on the GitHub repository.

Enjoy using NC News!