README.md

Enhancing API with MongoDB Integration

The project has been completed by

Helena Lee | Jan Vincent Villanueva

Tech Stack

Client

Server

DataBase

API

• DUE TO AZURE SUBSCRIPTION ISSUE, SOME FUNCTION MAY NOT WORK AS EXPECTED.

Project Objective

The project objective was to enhance the existing API by integrating MongoDB, allowing us to create, manage, and retrieve data from a local MongoDB database using a command-line interface (CLI) tool.

Demo

Screen.Recording.2023-10-03.at.11.34.16.AM.mov

Completed Tasks

Task 1: Seeded Cars Data into MongoDB

• Developed a CLI tool in Node.js to seed data into the local MongoDB database and provided the capability to delete data from it.
• Ensured that the CLI tool was source-controlled and included the seed data, enabling team members to seed data by cloning the repository.

Task 2: Displayed Similar Cars from Your Stock

• Modified the existing car-finder API to retrieve cars matching specified search criteria from the MongoDB instance.
• Optionally created a frontend page that allowed users to upload cars and view matched cars.

Getting Started

To get started with this enhanced API with MongoDB integration, follow these steps:

1. Clone this repository to your local development environment.

git clone https://github.com/HelenaMission/Matching-Car-Finder-with-MongoDB.git

2. Install MongoDB and MongoDB Compass locally using the provided installation guides.

3. Use the developed CLI tool to seed data into the local MongoDB database.

npm run build

npm i -g

• To seed data

mongocli2 seed

• To delete data

mongocli2 delete

• To find data

mongocli2 find

4. Open backend folder in terminal and run dev

npm run dev

5. Open frontend folder in terminal and run start script

npm start