Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 1.98 KB

README.md

File metadata and controls

44 lines (25 loc) · 1.98 KB
Raw

Thread Talk App

Description

This project is the front-end counterpart to my back-end project during my time in the Northcoders Software Development Bootcamp.

You can find the API here and the GitHub repo here.

This app is intended to simulate a service similar to Reddit. It has basic functionality such as the user being able to navigate between pages, browse articles, as well as vote and post/delete comments on articles.

Currently there is a hard-coded list of users to login as that are provided in the API, making it possible to post comments and delete your own comments as that user. This leaves space for extra functionality to be added, such as a user authentication page, posting/deleting articles, sorting and filtering articles etc.

You can find the hosted version of the app here.

Get started

Minimum requirements

  • Node: minimum version v20.8.0, you can download Node.Js here

How to run it

  1. Fork this repo by clicking on the icon in the top right of the page.

  2. Clone this repo by clicking the <>Code icon and copying the HTTPS url. Once the url is copied, go into your local terminal and run the following command once you're in the desired save location:

git clone <paste url here>

If you're using Visual Studio Code, you can either open the folder straight from the app by clicking open folder or, you can do this from your terminal, by running the following command:

code <folder name>

  1. Install Dependencies listed in the package.json to your machine by running npm install.

  2. Host a local version by running npm run dev.

If at any point you want to stop your script from running, click on the terminal and just press CTRL+C(Windows) or Command+C(Mac). Just remember to run npm run dev again to resume hosting.

  1. Happy coding! 😸