Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.18 KB

README.md

File metadata and controls

47 lines (30 loc) · 2.18 KB
Raw

Gossip with Go

This is a web forum application which is developed with a Go backend using the Go-Chi framework and a React frontend, and this is the repository for the frontend. The repository for the backend can be found here.

Getting Started

User Guide

  1. The web application is accessible at https://gossip-with-go.vercel.app/, and the user can browse threads without logging in. Sample threads and posts have been created to simulate a populated forum.

  2. The landing page consists of a list of all the threads, preceded by a component which allows you to filter the threads by tag by using the dropdown menu. Clicking on the threads will lead to a page with the comments associated with the thread.

  3. The user needs to login or register to create new threads or comments using the dialog which is rendered when clicking the account button.

  4. Once the user is logged in, the account button now opens a dialog which allows the user to change their username or password.

  5. The user now has the option to create new threads or comments by clicking the new thread button while viewing the list of threads or clicking the new comment button while viewing the specific thread respectively.

  6. If the user is logged in and is the original poster of the comment or thread they are viewing, they will also have the option to edit or delete their thread or comment.

Running the app locally

  1. Fork this repo.

  2. Clone your forked repo.

  3. Open your terminal and navigate to the directory containing your cloned project.

  4. Install dependencies for the project by entering this command:

    yarn install

  5. Run the app in development mode by entering this command:

    yarn start

  6. Open http://localhost:3000 to view it in the browser.

  7. You should see a page like this. Basic Page

Navigating the code

This is the main file structure