Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jss415 authored Oct 5, 2024
1 parent 466fb97 commit 64ffff7
Showing 1 changed file with 48 additions and 23 deletions.
71 changes: 48 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,61 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# Car Rental Services

## Getting Started
## Project Description

First, run the development server:
This project is a peer-to-peer car rental platform built using Next.js, inspired by Turo. The platform allows users to rent cars from local owners, providing an affordable and flexible alternative to traditional car rental services. Users can list their own vehicles, set pricing, and manage bookings through an intuitive interface, while renters can browse a diverse range of cars, filter by location, price, and vehicle type, and make reservations easily.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
## Tech Stack

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
NextJS, Typescript, TailwindCSS, Clerk, Supabase, Prisma, Shadcn, Zustand

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Features

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
- User can create a new account using their email or their Google Account through Clerk
- User profile creation and management
- User can create a new profile for his/her account
- User can upload their profile picture
- User can create, update, and delete his/her car rental listing
- Search functionality
- User can search rentals using car brand, make, and location
- User can favorite/unfavorite a car rental listing
- User can book a car rental using the booking system.
- Loading spinners
- Toast notifications for actions
- Creating/Deleting account
- Uploading profile picture
- Creating/Updating/Removing Car Listing
- Favoriting/Unfavoriting Car Listing

## Screenshots

![Screen Shot 2024-10-05 at 12 57 54 AM](https://github.com/user-attachments/assets/d014dcfb-1254-48a9-a19d-12fb8adfa57d)

Screenshot 1: Landing Page (Part 1)


![Screen Shot 2024-10-05 at 12 58 17 AM](https://github.com/user-attachments/assets/154da9d4-bd8e-468f-a25b-e0090f064cea)

Screenshot 2: Landing Page (Part 2)

![Screen Shot 2024-10-05 at 1 06 38 AM](https://github.com/user-attachments/assets/cd67d24b-afe9-4af9-9220-0cc3fdba1e13)

Screenshot 3: Updating profile

![Screen Shot 2024-10-05 at 1 05 42 AM](https://github.com/user-attachments/assets/a177a3e7-dd9f-4ea0-909b-a64a702e3225)

Screenshot 4: Creating a car rental listing (Part 1)

![Screen Shot 2024-10-05 at 12 59 13 AM](https://github.com/user-attachments/assets/b1e362d2-e745-41ab-8f44-2cdebfa3079d)

Screenshot 5: Creating a car rental listing (Part 2)

![Screen Shot 2024-10-05 at 12 59 58 AM](https://github.com/user-attachments/assets/d4e8fc77-bd87-49d8-9de2-294e6a2e9d4b)

Screenshot 6: Booking page (Shows all the car rental listings created by the user)

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

0 comments on commit 64ffff7

Please sign in to comment.