marquee - a project made by 6 happy students

Project Vision

For college students who need a safe and convenient way to buy, sell, and trade dorm essentials, clothes, and other items within their campus), Marquee is a college exclusive marketplace which ensures secure, student-only transactions through .edu email verification and focuses on campus-specific needs. Unlike other similar apps such as Facebook Marketplace, our product eliminates scammers, prioritizes affordability for students, and fosters a trusted, local community for buying and selling.

UI Prototype: https://www.figma.com/design/MeQ0h13gD7ehkUOBQTG1LN/Marquee%3A-Wireframes?node-id=36-40&p=f&t=vhCeTrkpiQV0WYu0-0

Wireframe: https://www.figma.com/proto/MeQ0h13gD7ehkUOBQTG1LN/Marquee%3A-Wireframes?node-id=110-22&starting-point-node-id=110%3A22

Class & Sequence Diagrams: https://www.figma.com/board/m09ipWSAiB344xhBuNDznC/TE4%3A-Authentication-and-Access-Contrtol?node-id=0-1&p=f&t=Dq4ZyuCFLlLRc2IT-0

Architecture

We are using the MERN (MongoDB, Express.js, React.js, Node.js) stack for this project. We use EmailJS for our emailing functionality.

How to Run

• npm install in root directory

Packages to Install (if you don't have already):

• npm i axios
• npm install --save @emailjs/browser

To run the backend locally:

• npm run dev in the backend directory
• make sure you create a .env file for TOKEN_SECRET so you can run it properly (ex. TOKEN_SECRET=hi)
• make sure you install dotenv as well (documentation online)
• make sure you include MONGO_CONNECTION_STRING in your env file! You can get the password from one of us and the link of the connection string is found in our shared database in Mongodb itself! So just paste it in! We need this in order to be able to connect our database to the backend!
• as of now since we have deployed using Azure, we have replaced all api's; to run this on your localhost, replace axios.js with http://localhost:8000 and backend.js with http://localhost:5173

Using Postman: Postman is a convenient way to test our API's

• when you download Postman, make sure your backend (npm run dev) is running! it will not work if you don't run it first
• make sure that you use http://localhost:8000 instead of the frontend's http://localhost:5173/ when testing on Postman, because it's the backend of course!
• copy paste the local host link into Postman, and make sure the type of HTTP request (GET, POST, PUT, etc) is correctly adjusted before hitting send
• console.log or inspect console on browser to check for error messages
• if your backend doesn't run and it talks about a cookie-parser, run: npm install cookie-parser

To run frontend:

• npm start in the frontend directory

How to Contribute

1. Clone the Forked Repo:

   git clone git@github.com:soramicha/307-team-project.git
   

2. Setup:

   npm install
   cd packages/frontend && npm install
   

3. Create a New Branch:

   git checkout -b feature-name
   

4. Commit Your Changes:

   git commit -m "feat: add new feature description"
   

5. Push to Your Branch:

   git push origin feature-name
   

6. Create a Pull Request (PR):

   • Go to the repo on Github
   • Click "New Pull Request"
   • Select your branch and submit the PR.

Code Guidelines

• Follow Prettier (npx prettier --write . to make all files align with Prettier format)
• Ensure your code is well-documented.
• Write meaningful commit messages.