Update readme content

.github/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to Auto Marketplace Client
+
+Thank you for considering contributing to the Auto Marketplace Client project! Your contributions are highly valued. Please take a moment to review the following guidelines.
+
+## Code of Conduct
+
+Please note that this project follows the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report any unacceptable behavior.
+
+## Reporting Issues
+
+If you encounter a bug, have a suggestion for improvement, or any other issue, please [open an issue](https://github.com/your-username/auto-marketplace-client/issues) on GitHub. Provide detailed information about the problem, including steps to reproduce it.
+
+## Feature Requests
+
+If you have an idea for a new feature, please open an issue to discuss it. We value your input and want to ensure new features align with the project's goals.
+
+## Development Setup
+
+To set up the project locally for development, follow the steps outlined in the [Getting Started](README.md#getting-started) section of the README.
+
+### Development Workflow
+
+1. **Branching**: Create a new branch for your feature, bug fix, or improvement.
+
+2. **Making Changes**: Make your changes, commit them, and push to your fork.
+
+3. **Opening Pull Requests (PRs)**: Open a PR against the `main` branch of the main repository. Provide a clear title and description for your changes.
+
+4. **Code Review**: Your PR will be reviewed by the maintainers. Address any feedback provided.
+
+5. **Merge**: Once your PR is approved, it will be merged into the main branch.
+
+### Testing
+
+Before opening a PR, ensure that your changes are covered by tests, if applicable. Run the tests locally.
+
+Fix any issues that arise during testing and linting.
+
+## Deployment
+
+The Auto Marketplace web app is deployed on Vercel. The build and deployment process is manually triggered by maintainers. Please be patient after your contributions are merged, as deployment updates may not be immediate.
+
+## Code Style
+
+Please adhere to the existing code style in the project. If there's a specific style or linting configuration, follow it.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).
+
+Thank you for contributing! 🚀

.github/workflows/dev-deploy.yml

@@ -3,9 +3,6 @@ env:
   VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
   VERCEL_PROJECT_ID: ${{ secrets.VERCEL_DEV_PROJECT_ID }}
 on:
-  push:
-    branches:
-      - main
   workflow_dispatch:
 jobs:
   deployment:

.github/workflows/release.yml

@@ -59,7 +59,4 @@ jobs:
           run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
         - name: Deploy Project Artifacts to Vercel
           run: vercel deploy --force --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
-        - uses: ncipollo/release-action@v1
-          with:
-            artifacts: "release.tar.gz,foo/*.txt"
-            bodyFile: "body.md"
+        - uses: ncipollo/release-action@v1

README.md

@@ -1,25 +1,60 @@
-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).
+# Auto Marketplace Client
+
+Welcome to the Auto Marketplace Client project! This platform is designed to provide users with a seamless and intuitive experience for buying and selling vehicles online.
+
+<p align="center">
+    <img alt="preview-image" src="public/images/banner.jpg" width="1024">
+</p>
+
+## Features
+
+1. **Free Vehicle Listings**
+   - List your vehicle for free on our platform. Reach a wide audience of potential buyers without any cost.
+
+2. **Advanced Search Filters**
+   - Easily find the vehicle that suits your needs with advanced search filters. Filter by make, model, year, price range, and more.
+
+3. **Subscription and Notifications**
+   - Subscribe to specific criteria and receive notifications whenever new listings matching your interests are added. Stay informed without constantly checking the platform.
+
+4. **Simple and Intuitive User Experience**
+   - We prioritize a clean and user-friendly design to ensure a straightforward experience for both buyers and sellers. Navigate through the platform with ease.
+
+## Tech Stack
+
+
+This project leverages [Next.js](https://nextjs.org/) version 14, incorporating the latest enhancements such as the app router and server components. Next.js is a powerful React framework designed for web application development. The complete tech stack includes:
+- **Next.js**: A robust React framework with version 14 features, including an advanced app router for intuitive navigation and server components for optimized server-side rendering.
+- **Vercel**: The web app is deployed on the edge network using Vercel, ensuring fast and reliable hosting with global reach.
+- **Tailwind CSS**: A utility-first CSS framework for crafting modern designs efficiently.
+- **DaisyUI**: Tailwind CSS extensions that streamline development and enhance styling capabilities.
+- **Auth0**: A flexible authentication and authorization platform.
+- **AWS S3**: A secure and scalable object storage service for efficient data storage and retrieval.
+- **ImageKit**: Real-time image optimization and transformation service.
+- **TypeScript**: A typed superset of JavaScript, improving code quality and maintainability.
+- **Zod**: TypeScript-first schema declaration and validation library.
+
+
 
 ## Getting Started
-To run dependencies
-```bash
-pnpm install
-```
 
-To run development server:
+**Note:**
+This repository contains the client-side code for the Auto Marketplace project. However, the backend code is currently private and not included in this repository. As a result, you won't be able to run the project locally without the backend.
+
+If you are interested in exploring the client-side code or contributing to the project, feel free to do so. Keep in mind that a fully functional local setup requires the backend, which is not publicly available at the moment.
+
+## Prerequisites
 
-```bash
-pnpm dev
-```
+To run the project locally, you need to have the backend set up separately. For access to the backend code and further details, please contact the project maintainers.
 
-To run build & run production server:
+## Contributing
 
-```bash
-pnpm build
-pnpm start
-```
+We welcome contributions! If you'd like to contribute to the client-side code or have questions about the project, please follow our [contribution guidelines](CONTRIBUTING.md).
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## License
 
+This project is licensed under the [MIT License](LICENSE).
 
+## Contact
 
+If you have any questions or feedback, feel free to reach out to us at [a.kajendran@gmail.com](mailto:a.kajendran@gmail.com).