Squirtle is a rideshare application designed specifically for UCLA students. Our goal is to enhance the university transportation experience, with a vision to expand to all universities. We aim to transform campus commutes, making them more efficient and affordable.
Our application is a way for students to find and create rides, and coordinate with students going on the same trips as them.
- Search/Filter Trips: Easily search for and filter trips based on various criteria.
- Create Trips: Users can create new trips by specifying the destination, pickup date, and time.
- Join Trips: Join existing trips that match your schedule and destination.
- Personalized Dashboard: View all your trips in a personalized dashboard for easy management.
- JavaScript
- Node.js
- React.js
- Express.js
- MongoDB
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
Clone the repository
git clone https://github.com/razorback4417/squirtle.git
-
Navigate into the main project folder
cd squirtle -
Install the project dependencies
npm install
-
Navigate into the
squirtleridefolder and start the development servercd squirtleride npm run dev
To setup the dependencies for the backend server, run:
cd backend
npm installThis will download a set of node_modules for the backend server.
Secrets
Create a .env file in the backend folder with the following contents:
PORT=4000
MONGO_URI=mongodb+srv://admin:[email protected]/?retryWrites=true&w=majority&appName=Cluster0
JWT_SECRET=1T69tOm+eGKj4aDFs6Irqcu8908dpoGvfsDANDk0UDMGD6CXXJGWiPh9EahJvPJk//bw1MQOZhiCBl40QUVbmA==
-
MONGO_URI: Obtain this from your MongoDB Atlas account or local MongoDB instance.
-
JWT_SECRET: Generate a secure key using the following command:
openssl rand -base64 64Running To start the backend server, run:
cd backend
npm run devNow, both the frontend and backend servers are running. You can access the application at http://localhost:3000 (or whatever port your environment is set to).
Squirtle was made as a project for CS 35L taught by Professor Paul Eggert at UCLA in Spring 2024. Made by: Alex Zheng, Kevin Sun, Nathan Zhang, and Theo Luu.