Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.62 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.62 KB
Raw

React-based Gossip App with Material UI Library Project

This frontend app, named NUS Grapevine, allows online users to interact with each other on a web forum-like page and discuss topics relevant to certain tags, such as academics, extracurriculars and entertainment. This project was made as a submission to the NUS CVWO assignment 2023/2024. This app wil support several features:

  • User authentication and registration: Users can sign up for an account, solely authenticated by their username.
  • Post creation: Author can create new posts with a title, text content and several tags if necessary.
  • Post management: Author can view, edit, and delete their own posts.
  • Commenting and Liking: Users can add and edit comments and add likes to posts.

Getting Started

To visit the deployed version of this website, you may check out https://nusgrapevine.netlify.app. Otherwise, to get a local copy up and running, note the prerequisites and follow these steps.

Prerequisites

  • React
  • Typescript
  • NPM
  • Git and Github
  • Any code editor (VSC, Brackets, etc)

Instructions

  1. Go to https://github.com/jayjay19630/gossip-app-backend and start the backend on your computer.
  2. Open terminal
  3. Navigate to your desired location to place this repository
  4. Copy and paste the following code into the terminal: git clone https://github.com/jayjay19630/gossip-app-frontend
  5. Run cd gossip-app-frontend
  6. Run npm install
  7. Navigate to config.tsx file in root directory. Change onLocalComputer to true and on RenderDeploy to false.
  8. Run npm run dev
  9. Open http://localhost:5173 to view the app