A web platform for reading articles, participating in discussions through comments, and engaging with content via voting.
- Backend (API): Repository • Live Demo
- Frontend (Web App): Repository • Live Demo
- Retrieve, sort, and filter articles by topic
- Post new articles
- Vote on articles and comments
- Post and delete comments
- Display articles by specific topics
- RESTful endpoints with JSON responses
- Framework: React (v18.3)
- Build Tool: Vite (v6)
- Routing: React Router (v7)
- Styling: CSS, Tailwind CSS (v4)
- HTTP Client: Axios
- Deployment: Netlify
Before development, make sure you have the following installed:
- Node.js (v20.15.1 or higher)
- npm (10.8.2 or higher)
- Git
- Clone the repository
git clone https://github.com/loklokyuen/nc-news.git && cd nc-news
- Install dependencies
npm install
- Start the project locally
npm run dev
- The development server runs on localhost:5173 by default. The terminal will display the exact URL after running
npm run dev. Follow the link to view your changes in real-time.
This project is deployed using Netlify. To deploy your own version, connect the repository to Netlify and run the build command:
npm run build
The site will be built and deployed automatically on every push to the main branch.
This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders