Skip to content

TheByteBoard is the frontend architecture for the backend news API. Both Frontend and Backend has been made by myself, making this a complete Full-Stack application. It is a news service with liking, commenting, sorting, filtering functionalities, and is built off similar services such as Reddit.

Notifications You must be signed in to change notification settings

JoravarSinghPunia/FRONTEND-NEWS-API

Repository files navigation

The Byte Board

Links

You can access the live version of this app here.

This application makes use of the backend API created myself that you can find here

About

The Byte Board is a service built for the purpose of reading, viewing, commenting, sorting and liking recent news articles. Modelled after real world services, such as Reddit, this application makes use of information provided from my backend API. The project was created with React and is now live and deployed on Netlify.

The development process was driven by a set of user stories, illustrated using wireframes based on mobile-first principles. A component tree was then used to define the structure of the site, with consideration to Reacts state, props and context, as well as API calls and queries. Each user story was completed with its own ticket, with frequent code reviews from Senior Software Engineers.

Softwares/Libraries

NPM, Vite, Axios, React with React Router

Instructions for running the program locally:

Clone the repository

In order to see the Frontend application, you can fork and clone the repository using the git clone command in your terminal. This should be run in the directory where you want to save it.

https://github.com/JoravarSinghPunia/FRONTEND-NEWS-API

Note: Forking the repository will require you to use the link provided from the forked repo.

Install dependencies

This project uses various dependencies in order to run. Failure to install these dependencies will result in the server producing errors. Install all dependencies by running the following commands in your VSCode integrated terminal within the repo.

npm install

Note: If you get vulnerabilities, follow the instruction given on the terminal. Use the following command to fix this:

npm audit fix

Run site locally

npm run dev

Node versions

The version of Node used to run this project is 20.10.0

About

TheByteBoard is the frontend architecture for the backend news API. Both Frontend and Backend has been made by myself, making this a complete Full-Stack application. It is a news service with liking, commenting, sorting, filtering functionalities, and is built off similar services such as Reddit.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published