Skip to content

Commit

Permalink
readme added
Browse files Browse the repository at this point in the history
  • Loading branch information
Md-Musfikur-Rahman committed Sep 17, 2023
1 parent c45e8a2 commit 622f506
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 21 deletions.
52 changes: 31 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,44 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Car Rental Website

## Getting Started
## Introduction

### Welcome to the car rental website project

This Next.js and TypeScript-powered car rental website aims to provide a seamless car rental experience with the motto, "Find, book, or rent a car -- quickly and easily!" The website offers a range of functionalities, including user registration, advanced car search based on brand, model, fuel type, and build year. During the development phase, we tackled challenges related to TypeScript, form validation, and user authentication.

First, run the development server:
## Key Features

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
- **User Registration:** Securely register user accounts and unlock personalized features.
- **Advanced Car Search:** Discover the ideal car by specifying brand, model, fuel type, or build year.
- **Effortless Booking:** A user-friendly booking process ensures a smooth rental experience.
- **Responsive Design:** The website seamlessly adapts to various devices and screen sizes.

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Development Challenges and Solutions

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
During our development journey, we faced several challenges:

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
1. **TypeScript Type Errors:** We achieved type safety and resolved type errors through rigorous code reviews and TypeScript best practices.
2. **Form Validation:** Robust form validation was implemented using libraries like Formik and Yup to enhance data accuracy and security.
3. **User Authentication:** We established a secure user authentication and authorization system using technologies like JWT tokens and bcrypt hashing.

## Getting Started

## Learn More
### To start contributing to this project, follow these steps:

To learn more about Next.js, take a look at the following resources:
1. Clone this repository.
2. Install the necessary dependencies using `npm install`.
3. Configure your environment variables.
4. Launch the development server with `npm run dev`.

- [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.
We welcome contributions, bug reports, and feature requests through pull requests and issues. Happy coding!

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
For a live demo, visit [Demo Link](https://cars-shows.vercel.app).

## Deploy on Vercel
## Socials

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.
[LinkedIn](https://www.linkedin.com/in/mdmusfikurrahman)
[Instagram](https://www.instagram.com/mdmusfikurrahman23)
[FaceBook](https://www.facebook.com/mdmusfikurrahman23)
[Twitter](https://twitter.com/musfikurahman)

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
![Screenshot](Screenshot.png)
Binary file added Screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 622f506

Please sign in to comment.