Wingman

Description

Our project coordinates rideshares between a university campus and the airport. The goal is to help users quickly find reasonable matches tailored to their specific needs. This website is designed primarily for university students seeking a budget-friendly and more personalized method of finding rideshare companions. The platform will offer multiple features addressing both safety and logistical factors that riders must consider when choosing rides to share.

Technical Specifications

• Languages: JavaScript, Typescript
• Database: MongoDB
• Object Data Modeling (ODM) Library: Mongoose
• Framework: Express.js
• Testing: Jest
• UI Library: Shadcn
• Authentication: Firebase
• API Testing Platform: Postman
• API Architecture: REST

Prerequisites

Make sure you have the following installed:

• Node.js (v16+ recommended)
• npm (comes with Node.js)

Running the App Locally

Follow these steps to start the backend and frontend servers (locally):

Follow the instructions in backend/src/app.js and comment out the code for vercel deployment.

1. Start the Backend

Open a terminal and run:

cd backend
npm install
npm run start

2. Start the Frontend

cd frontend
npm install
npm run dev

3. Local Development

Head to the PORT shown in the terminal.

Deployed Version

Follow wingman-for-you.vercel.app/ to view the deployed version. The frontend is deployed on Vercel and the backend is deployed on Render.