Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oezeb/ustc-market
A market for USTC Students
https://github.com/oezeb/ustc-market
Last synced: 9 days ago
JSON representation
A market for USTC Students
- Host: GitHub
- URL: https://github.com/oezeb/ustc-market
- Owner: oezeb
- Created: 2023-10-05T09:10:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-28T15:10:30.000Z (12 months ago)
- Last Synced: 2024-04-20T09:08:14.304Z (7 months ago)
- Language: JavaScript
- Homepage: https://www.ustc.market
- Size: 416 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# USTC Market
USTC Market is a web application, built using the MERN stack, that allows users to buy and sell items. This project was inspired by the need for many international students to sell or give away their items before returning to their home countries.
This project hopes to provide a platform for students to exchange items with each other, and to reduce the amount of waste produced by students who are unable to bring their items back home.
USTC Market will only provide basic functionalities such as user authentication, item listing, and messaging. It will not provide payment services or delivery services. The aim of this project is to help connect buyers and sellers, and to provide a platform for them to communicate and arrange for meetups.
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/)
- [npm](https://www.npmjs.com/)
- [MongoDB](https://www.mongodb.com/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/oezeb/ustc-market.git
```
2. Setup [server](./server/README.md#installation)
3. Setup [client](./client/README.md#installation)
## Features
### User Authentication
- [ ] Users can sign in using the university SSO
- [x] ~~No public facing registration page. Admins can create new users if necessary.~~
- [x] Users can register using their university email address
- [x] Users can sign in using their username and password
- [x] Users can change basic profile information including password
- [x] Admins can help users reset their passwords
### Item Listing
- [x] Users can create new listings
- [x] Users can edit their own listings
- [x] Users can view all listings
### Messaging
- [x] Messages should be private and encrypted
- [x] Users can send messages to other users regarding a listing
- [x] The owner of a listing cannot initiate a conversation with a user who has not contacted them first about the listing
- [ ] Use socket.io to allow for real-time messaging
- [x] Users can block other users from contacting them
### Privacy
- [x] Users are anonymous by default
- [x] Including the messaging feature, users can choose to share their contact information privately with other users
## Contributing
### Code Style
This project uses [Prettier](https://prettier.io/) to enforce code style. Please ensure that your code is formatted using Prettier before submitting a pull request.
#### Prettier Options
```json
{
"arrowParens": "always",
"bracketSpacing": true,
"endOfLine": "lf",
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"singleAttributePerLine": false,
"bracketSameLine": false,
"jsxBracketSameLine": false,
"jsxSingleQuote": false,
"printWidth": 80,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": true,
"singleQuote": false,
"tabWidth": 4,
"trailingComma": "es5",
"useTabs": false,
"embeddedLanguageFormatting": "auto",
"vueIndentScriptAndStyle": false,
"parser": "babel"
}
```