This is a news application built with React for the frontend, using React Router for navigation and Context API for state management. Axios is used for API calls. The platform allows users to read and interact with articles on various topics.
You can access the deployed version of the app here: FE NC News
The backend for this project is available at: BE NC News
FE NC News is a frontend application that allows users to view articles, vote on them and add comments. The app provides different categories of articles and users can filter articles by topics. Users can also log in to interact more deeply with the content.
- View a list of articles
- Filter articles by topic
- View individual articles with detailed content
- Vote on articles
- Add and delete comments on articles
The minimum version of Node required to run this project locally is v16.0.0
.
To run this project locally, follow these steps:
-
Clone the repository
git clone https://github.com/your-repo/fe-nc-news.git
-
Navigate to the project directory
cd fe-nc-news
-
Install the dependencies
npm install
-
Create a .env file in the root of your project.
If you are adding your own API, please make sure you are following the documentation on how to structure it here. You can find there a detailed information on available endpoints, request methods, and examples.
Recommended extension to view JSON files JSON Viewer Pro.
And add either the nc-news backend API as below or your own API base URL.
VITE_API_URL=https://nc-news-ivory.vercel.app/api
-
Run the development server
npm run dev
-
Build the project for production
npm run build
-
Preview the production build
npm run preview
This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders.