Welcome to Car Mart Frontend! This project is a MERN (MongoDB, Express.js, React, Node.js) stack application aimed at managing a car dealership's inventory, customers, and sales records. This README will guide you through the setup and usage of the frontend part of the Car Mart project.
- React with Typescript: The frontend is built using React.js, a popular JavaScript library for building user interfaces, alongwith Typescript for static typing.
- Material UI: Material UI is utilized for designing the user interface components, providing a sleek and modern look.
- React Router: React Router is used for client-side routing, enabling seamless navigation between different pages of the application.
- Axios: Axios is employed for making HTTP requests to interact with the backend API endpoints.
- React Hook Form: React Hook Form is utilized for managing form state and validation in a React application.
- Yup: Yup is used for form validation, ensuring that user inputs meet specified criteria.
- CRUD Operations: Car Mart Frontend offers CRUD (Create, Read, Update, Delete) functionalities for managing car inventory, customers, and salesperson records.
- Cars Inventory Management: Easily add, edit, or delete cars from the inventory.
- Customer Management: Maintain a list of customers and their details.
- Sales Records: Keep track of cars sold by salespersons, including details such as buyer information, sale price, and date of sale.
To run the Car Mart Frontend locally, follow these steps:
-
Clone the Repository: Clone the Car Mart repository to your local machine using the following command:
git clone https://github.com/saadshd/car-mart-frontend.git
-
Install Dependencies: Navigate into the cloned directory and install the required dependencies using npm or yarn:
cd car-mart-frontend npm install
-
Set Up Environment Variables: Create a
.env
file in the root of the project and add the necessary environment variables, such as API endpoint URLs. -
Start the Development Server: Once the dependencies are installed, start the development server using the following command:
npm start
-
Access the Application: Open your web browser and navigate to
http://localhost:3000
to access the Car Mart Frontend.
Contributions to Car Mart Frontend are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
Thank you for using Car Mart Frontend! If you have any questions or need further assistance, feel free to reach out. Happy coding! 🚗🛠️