Car Warehouse Management System

Table of Contents

• Project Description
• Project Requirements
• Installation
• Usage
• Deployment
• Contributing
• License

Project Description

The Car Warehouse Management System is a backend application developed in Node.js and Express.js. It provides a simple inventory management system for managing cars stored in a warehouse. The application allows you to perform operations such as adding new cars, retrieving existing cars, and deleting cars from the inventory.

Project Requirements

• Server-Side Language: Node.js
• Database: MySQL or any other relational database
• API: Develop a backend API for managing the car warehouse
• Deployment: Deploy the application using Heroku
• Documentation: Include setup, usage, and deployment instructions

Installation

To run the Car Warehouse Management System locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/MostafaMGomaa/Car-Warehouse.git

2. Navigate to the project directory:

   cd car-warehouse-management

3. Install the dependencies:

   npm install

4. Set up the database:

   • Create a MySQL database and update the database configuration in the .env file.
   • Here's an example of the .env file:

     DB_HOST=localhost
     DB_PORT=3306
     DB_USER=myusername
     DB_PASSWORD=mypassword
     DB=mydatabase-name
     

5. Start the application:

   npm start

Usage

The Car Warehouse Management System provides the following API endpoints:

• GET /cars: Retrieve all cars from the warehouse inventory.
• GET /cars/:id: Retrieve a specific car by ID.
• POST /cars: Add a new car to the warehouse inventory.
• PUT /cars/:id: Update a specific car by ID.
• DELETE /cars/:id: Delete a specific car by ID.

Refer to the API documentation for detailed information on how to use each endpoint.

Deployment

The Car Warehouse Management System can be deployed using Heroku. Follow these steps to deploy the application:

1. Create a Heroku account if you don't have one.

2. Install the Heroku CLI by following the instructions in the Heroku Dev Center .

3. Log in to Heroku from the command line:

   heroku login

4. Create a new Heroku app:

   heroku create car-warehouse

5. Set up the MySQL database on Heroku using addons or an external service.

   • Update the database configuration in the .env file with the Heroku database credentials.

6. Deploy the application to Heroku:

   git push heroku main

7. Start the app on Heroku:

   heroku ps:scale web=1

8. Open the deployed app in the browser:

   heroku open

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.