Skip to content

anaggomes/nc-news

Repository files navigation

Northcoders News Frontend

Welcome to my frontend project!

This project is the frontend of Northcoders News, a Reddit-like application, developed using React + Vite and deployed with Netlify. It serves as the user interface for interacting with the backend API, which was created using Node.js and PostgreSQL.

The deployed version of this project can be found on https://ncnews-live.netlify.app/
(please be aware that it can take a few minutes for the server to restart)

Northcoders News Backend GitHub repository: https://github.com/anaggomes/be-nc_news.git

Features

This app provides platform where users can share articles, comment on them, and vote for their favorites.

  • View a list of articles
  • View a list of topics
  • View individual articles
  • View comments for each article
  • Add new comments to articles
  • Vote on articles and comments
  • Sort articles by date, votes, or comment count
  • Error handling for various scenarios

Currently working on:

  • Post a new article
  • User's profile
  • Find articles by author or article_id
  • See other users
  • Create a new topic

Getting Started

To run this project locally, follow these instructions:

Prerequisites

Before running the server, make sure you have the following installed on your machine:

  • Node.js v21.7.1

Installation

  1. Clone the repository

    git clone <repository-url>

  2. Navigate into the project directory:

    cd nc-news

  3. Install the dependencies

    npm install

Usage

  1. Start the development server:

npm run dev

  1. Open your browser and navigate to the the local url provided by VITE to view the application.

Log In

Please use one of the following usernames to log in, and any password (as long as it is not empty) will work:

  • tickle122
  • grumpy19
  • happyamy2016
  • cooljmessy
  • weegembump
  • jessjelly

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

Acknowledgments

This project was developed as part of the Northcoders Software Development bootcamp curriculum.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published