Skip to content

Commit c0382ce

Browse files
committed
Update Readme
1 parent fb0498a commit c0382ce

File tree

1 file changed

+41
-53
lines changed

1 file changed

+41
-53
lines changed

README.md

+41-53
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,54 @@
1-
# Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB
1+
<div align="center">
22

3-
[![forthebadge](https://forthebadge.com/images/badges/uses-html.svg)](https://forthebadge.com)
4-
[![forthebadge](https://forthebadge.com/images/badges/uses-css.svg)](https://forthebadge.com)
5-
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)
3+
<br>
4+
<img src="docs/assets/autorizz.png" height="80" alt="Autorizz" />
65

7-
[![HitCount](http://hits.dwyl.com/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB.svg)](http://hits.dwyl.com/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB)
6+
# Car-Dealership-System-using-NodeJS-Express-MongoDB
87

9-
#### It is a web app that is helps increase productivity in automobile garages.The automobile dealership management application is a web-based system that facilitates the management of an automobile dealership with the help of sub systems each handling different functionalities like vehicle sales which maintains and tracks all the details regarding the sale of vehicles, service which tracks the vehicles that are currently being serviced by the dealership, spare inventory which maintains the stocks of the spares in the inventory. This approach of modular solution helps in resolving the bugs faster and increases the pace of development since these can be developed separated but can be tested together.
8+
![GitHub last commit](https://img.shields.io/github/last-commit/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB?label=Last%20commit&color=green&logo=git&logoColor=white&style=flat)
9+
![GitHub stars](https://img.shields.io/github/stars/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB?label=Stars&logo=github&style=flat)
10+
![Github forks](https://img.shields.io/github/forks/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB?label=Forks&logo=github&style=flat)
11+
![GitHub issues](https://img.shields.io/github/issues/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB?label=Issues&color=yellow&logo=github&style=flat)
12+
![GitHub License](https://img.shields.io/github/license/defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB?label=License)
13+
[![GitHub All Releases](https://img.shields.io/github/downloads/defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB/total?label=Downloads&color=blue)](https://github.com/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB/releases)
14+
<!-- [![GitHub pull requests](https://img.shields.io/github/issues-pr/Defcon27/Autorizz-Car-Dealership-System-using-NodeJS-Express-MongoDB)](https://github.com/sarthakpranesh/cosmos.ReactNative/pulls) -->
1015

11-
## ABSTRACT
12-
Automobile Dealership Management System software is a web-based application developed to manage and track the details of vehicle sales, workshop and service, spare parts inventory and their customers can search and then view the complete specification of each vehicle listing with its features and buy the vehicle as per their requirements. This is a simple yet efficient management system to manage records of dealership data instead of using traditional methods to manage data like manual records or file systems. Their customers can always be in the comfort of their homes to check the various vehicles, spare parts listed in the website for sale as to their choice. Hence reducing the cost, saving time and increasing the comfort of their customers.
13-
In the case of a traditional method where the sales and purchase records are stored manually through registers or file systems which is very time consuming and inefficient. Moreover, in this kind of management, there is lots of paperwork involved for the generation of bills, reports, invoices for every transaction which needs to be sorted and maintained manually which are prone to human. The management of these manual records is very hard, productivity is lost using manual records, searching of manual records is tedious, the security of records is unreliable.
16+
</div>
17+
<br/>
1418

19+
## What is Autorizz?
1520

16-
## INTRODUCTION
17-
This Automobile Dealership management system is a digitalized web-based application where the entire records are maintained by the database management system itself. It provides an intuitive user interface, which is easy to use, for both the dealers and their customers.In this system, the dealer or the customer first needs to authenticate themselves to start using the application. Here dealer can log in with their given ID and password in order to manage the website. The dealer can post the vehicles that needs to be sold by the dealership in vehicle sales. The customers of the dealership can register and log into the website. Here the customers can browse through various vehicles listed on the website which enables the customer to find the vehicle as per his/her requirements. Customers can search vehicles in the sales and can then view the complete specification of each vehicle listing with its features, price, etc. according to their requirements and can book the vehicle by initiating a purchase. Then the customer needs to pay the dealership the price of the property that the customer wants to purchase. After the successful completion of the transaction process, the vehicle will be booked under that customer. The customer can service their vehicle in the dealership and the system tracks this information and informs the customer of pickup. Also, customers can buy spare parts from the dealership with the help of spare part inventory and similarly buy the required components by the customer and can check out.
21+
#### Autorizz is a web-based application developed to provide digital retail services to automotive dealerships in order to facilitate zero-contact sales and services. It manages and track the entire vehicle sales, service, parts inventory seamlessly connecting the dealership increasing its efficiency. The customers can browse and then view the complete specification of each vehicle listing with its features and buy the vehicle as per their requirements creating an awesome retail experience to the customer. This is a simple yet efficient management system to manage records of dealership data instead of using traditional methods to manage data like manual records or file systems. Their customers can always be in the comfort of their homes to check the various vehicles, spare parts listed in the website for sale as to their choice. Hence reducing the cost, saving time and increasing the comfort of their customers.
22+
<br>
1823

1924

20-
## MODULE DESCRIPTION
21-
This web app consists of modules with different tasks and outputs. Automobile Dealership Management system consists of different modules like vehicle sales, vehicle service, and spares inventory.
22-
### VEHICLE SALES
23-
Vehicle sales includes managing the vehicle details which contains the model of the vehicle, price etc. that are currently available, and the vehicles and vehicle Booking includes the details of customer who bought that vehicle and the model of the vehicle that got booked by the customer. Customers can search vehicles in the sales and can then view the complete specification of each vehicle listing with its features, price, etc. according to their requirements and can book the vehicle by initiating a purchase. Payment and Transactions includes the payment option, cost of the product, name of the bank and user id.
2425

25-
### VEHICLE SERVICE:
26-
Vehicle service consists of the no. of the vehicles that are currently being serviced and the vehicles that got serviced and delivered to the customer recently and it consists of the status of vehicles that are currently being served and gets notified to the customer when it completes.
26+
### Application Structure
27+
```
28+
29+
├── bin
30+
├── models (MongoDB Mongoose Models)
31+
├── node_modules
32+
├── public (application resources - css, js, images)
33+
├── routes (handles admin, electric and gas routes)
34+
├── views (express-handlebars templates)
35+
├── admin (admin templates)
36+
├── layouts (default layout templates)
37+
└── electric and gas template files
38+
├── app.js (root Node app script)
39+
├── package.json
40+
└── README.md
41+
```
2742

28-
### SPARES INVENTORY:
29-
Spares Inventory includes the details of spares available in the inventory and purchase history of spares and it also includes the payment details of the purchase of spare parts. Here customers can buy spare parts from the dealership with the help of spare part inventory and similarly buy the required components by the customer and can check out.
3043

31-
## WEB APP
32-
LOGIN
44+
#### General
45+
1. Install Dependencies using `npm install`
46+
2. Make sure `MongoDB` server is running
3347

34-
<img src='Auto_media/readme/login.png' width=90% height=90%/>
3548

36-
AUTORIZZ
37-
38-
<img src='Auto_media/readme/app.gif' width=90% height=90%/>
39-
40-
AUTO SHOP
41-
42-
<img src='Auto_media/readme/shop.png' width=90% height=90%/>
43-
44-
BOOKING
45-
46-
<img src='Auto_media/readme/book.png' width=90% height=90%/>
47-
48-
AUTO GARAGE
49-
50-
<img src='Auto_media/readme/service.png' width=90% height=90%/>
51-
52-
53-
#### USE CASE DIAGRAM
54-
<img src='Docs/use%20case.png' width=60% height=60%/>
55-
56-
57-
### Instruction to setup
58-
- Clone the Repo
59-
- Install dependencies using `npm install`
60-
- MongoDB server should be running with appropriate data
61-
- Move into AutoGarage source folder
62-
- Run `npm start`
63-
- Launch app in browser `localhost:5000`
64-
65-
### Report
66-
[Full Report Here](Docs/SW%20REPORT.pdf.pdf)
49+
#### Local
50+
1. Inside `--> app.js` under MongoDB section, replace the url with `mongodb://localhost:27017/autorizz`
51+
2. Open Terminal in the app folder
52+
3. Run `npm start` or `nodemon start` (if nodemon is preinstalled)
53+
4. Launch client app in `localhost:5000`
54+
4. Launch admin app in `localhost:5000/admin`

0 commit comments

Comments
 (0)