From e152cde12ef0bca0549e9ef40ecba2be8d68ee2c Mon Sep 17 00:00:00 2001 From: Sophia Date: Mon, 29 Apr 2024 23:06:20 -0400 Subject: [PATCH] Update README.md --- README.md | 68 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 39 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 8492867..eb0a355 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,40 @@ # Georgia Tech Marketplace - -## Relevant Links - -- https://github.com/alan2207/bulletproof-react - - -Use ```npm run dev``` to run the application. - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} -``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +Group project for CS 4675 @ GT + +### Our Motivation +Georgia Tech Marketplace is a web app for Georgia Tech students looking to sell or buy items. +Thousands of students move in and out of Georgia Tech every year and alongside them, commonplace goods and items for college living. +The problem is that many students do not want to spend a lot of money buying new items from stores that they are not sure they will use for longer than a year or semester. +This leads to using platforms like Facebook marketplace, Ebay, or Craigslist, which often have scams or have other credibility and safety concerns. + +We aim to address the lack of a safe platform for buying and selling items within the Georgia Tech community through the Georgia Tech Marketplace. +This web allows students of Georgia Tech to sell used goods or offer monetary services within the GT community. + +⚠️ This web application can only be used with an official GT email (@gatech.edu). ⚠️ + +**Technology:**
+HTML, Tailwind CSS, React.js, Firebase, Firebase Realtime Database + +## Preview +#### Login Page +![alt text](https://i.imgur.com/IADfZBx.png "GT Marketplace Login") +#### Dashboard and Listings +![alt text](https://i.imgur.com/2JaaJc0.png "GT Marketplace Dashboard") +View all recent listings on the Dashboard or filter items through selecting categories or searching. +#### Item Listing +![alt text](https://i.imgur.com/xXTA8ud.png "GT Marketplace Item Listing") +When viewing items, you can "Add to Favorite" to view listings later.
+If you are interested in an item, click on "Contact Seller" to begin chatting with the seller. +#### User Listings +![alt text](https://i.imgur.com/RCXHzOP.jpeg "GT Marketplace Create and View Listings") +View all your current listings on this page.
+If you have something to sell, click "Add New Listing" and create a listing. +#### User Profile and Favorited Listings +![alt text](https://i.imgur.com/ybE9xG0.png "GT Marketplace User Profile") +View information about yourself on your profile and view listings you have previously favorited. +#### Messaging +![alt text](https://i.imgur.com/1EGo5XX.png "GT Marketplace Chat") + +## Installation and Set Up +1. Use ```npm install``` to install dependencies. +2. Use ```npm run dev``` to run the application on your local host.