Objective: Develop a Express application with TypeScript as the programming language, integrating MongoDB with Mongoose for effective data management. Ensure data integrity through validation using Joi/Zod.
- Create a new Express project.
- Set up a MongoDB database using Mongoose for storing product and order data.
- Create Mongoose models for Product data based on the provided data structure. (You can follow sample-data.json file for ideas).
- Define appropriate data types, validations.
- name (string):
- The name of the product.
- description (string):
- A brief description of the product.
- price (number):
- The price of the product.
- category (string):
- The category to which the product belongs.
- tags (array of strings):
- An array of tags or keywords associated with the product.
- variants (array of objects):
- An array containing different variants or options of the product, such as size, color, or style.
- type (string): The type of variant (e.g., size, color).
- value (string): The specific value of the variant (e.g., "Small", "Red").
- An array containing different variants or options of the product, such as size, color, or style.
- inventory (object):
- An object representing the product's inventory details.
- quantity (number): The available quantity of the product in stock.
- inStock (boolean): Indicates whether the product is currently in stock.
- An object representing the product's inventory details.
-
Endpoint:
/api/products -
Method:
POST -
Sample Request Body:
{ "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 50, "inStock": true } } -
Sample Response:
{ "success": true, "message": "Product created successfully!", "data": { "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 50, "inStock": true } } }
-
Endpoint:
/api/products -
Method:
GET -
Sample Response:
{ "success": true, "message": "Products fetched successfully!", "data": [ { "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 50, "inStock": true } }, { "name": "Samsung Galaxy S21", "description": "High-performance Android smartphone with advanced camera capabilities.", "price": 799, "category": "Electronics", "tags": ["smartphone", "Samsung", "Android"], "variants": [ { "type": "Color", "value": "Phantom Black" }, { "type": "Storage Capacity", "value": "128GB" } ], "inventory": { "quantity": 30, "inStock": true } } // Additional products can be added here... ] }
-
Endpoint:
/api/products/:productId -
Method:
GET -
Sample Response:
{ "success": true, "message": "Product fetched successfully!", "data": { "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 50, "inStock": true } } }
-
Endpoint:
/api/products/:productId -
Method:
PUT -
Sample Request Body:
{ "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 50, "inStock": true } } -
Sample Response:
{ "success": true, "message": "Product updated successfully!", "data": { "name": "iPhone 13", "description": "A sleek and powerful smartphone with cutting-edge features.", "price": 999, "category": "Electronics", "tags": ["smartphone", "Apple", "iOS"], "variants": [ { "type": "Color", "value": "Midnight Blue" }, { "type": "Storage Capacity", "value": "256GB" } ], "inventory": { "quantity": 49, "inStock": true } } }
-
Endpoint:
/api/products/:productId -
Method:
DELETE -
Sample Response:
{ "success": true, "message": "Product deleted successfully!", "data": null } // The product should be deleted from the database.
- Endpoint:
/api/products?searchTerm=iphone - Method: GET
- Sample Response:
{
"success": true,
"message": "Products matching search term 'iphone' fetched successfully!",
"data": [
{
"name": "iPhone 13 Pro",
"description": "The latest flagship iPhone model with advanced camera features.",
"price": 999,
"category": "Smartphones",
"tags": ["iPhone", "Apple", "Mobile"],
"variants": [
{
"type": "Color",
"value": "Graphite"
},
{
"type": "Storage",
"value": "256GB"
}
],
"inventory": {
"quantity": 50,
"inStock": true
}
},
{
"name": "iPhone SE",
"description": "Compact and affordable iPhone model with powerful performance.",
"price": 399,
"category": "Smartphones",
"tags": ["iPhone", "Apple", "Mobile"],
"variants": [
{
"type": "Color",
"value": "White"
},
{
"type": "Storage",
"value": "128GB"
}
],
"inventory": {
"quantity": 20,
"inStock": true
}
}
]
}-
Endpoint:
/api/orders -
Method:
POST -
Request Body:
{ "email": "level2@programming-hero.com", "productId": "5fd67e890b60c903cd8544a3", "price": 999, "quantity": 1 } -
Response:
{ "success": true, "message": "Order created successfully!", "data": { "email": "level2@programming-hero.com", "productId": "5fd67e890b60c903cd8544a3", "price": 999, "quantity": 1 } }
-
Endpoint:
/api/orders -
Method:
GET -
Sample Response:
{ "success": true, "message": "Orders fetched successfully!", "data": [ { "email": "level2@programming-hero.com", "productId": "5fd67e890b60c903cd8544a3", "price": 999, "quantity": 1 } // more orders... ] }
-
Endpoint:
/api/orders?email=level2@programming-hero.com -
Method:
GET -
Sample Response:
{ "success": true, "message": "Orders fetched successfully for user email!", "data": [ { "email": "level2@programming-hero.com", "productId": "5fd67e890b60c903cd8544a3", "price": 999, "quantity": 1 } // more orders for the user... ] }
Inventory Update:
When creating new order (/api/orders ) ,reduce the quantity of the ordered product in inventory and update the inStock property.
- When a new order is created, the system should check the available quantity in inventory.
- If the ordered quantity exceeds the available quantity, return an error response indicating insufficient stock.
- Update the inventory quantity and
inStockstatus based on the ordered quantity:- If the inventory quantity reaches zero, set
inStocktofalse. - Otherwise, keep
inStockastrue.
- If the inventory quantity reaches zero, set
- Insufficient Quantity Error
{
"success": false,
"message": "Insufficient quantity available in inventory"
}- Not Found Error
{
"success": false,
"message": "Order not found"
}- Not Found Route
{
"success": false,
"message": "Route not found"
}- Use Joi/Zod to validate incoming data for product and order creation and updating operations.
- Ensure that the data adheres to the structure defined in the models.
- Handle validation errors gracefully and provide meaningful error messages in the API responses.
- Coding Quality:
- Write clean, modular, and well-organized code.
- Follow consistent naming conventions for variables, functions, and routes.
- Use meaningful names that reflect the purpose of variables and functions.
- Ensure that the code is readable.
- Comments:
- Try to provide inline comments to explain complex sections of code or logic.
- API Endpoint Adherence:
- Strictly follow the provided API endpoint structure and naming conventions.
- Ensure that the request and response formats match the specifications outlined in the assignment.
- Validation and Error Handling:
- Implement validation using Joi/Zod for both user and order data.
- Handle validation errors gracefully and provide meaningful error messages in the API responses.
- Implement error handling for scenarios like user not found, validation errors.
- Coding Tools and Libraries:
- Avoid the use of AI tools or libraries for generating code. Write the code manually to demonstrate a clear understanding of the concepts.
- Utilize only the specified libraries like Express, Mongoose, Joi and avoid unnecessary dependencies.
- Coding Style:
- Consider using linting tools (e.g., ESLint) to enforce coding style and identify potential issues.
- Ensure there are at least 10 commits in your GitHub repository.
Not following the specified API endpoint structure, naming conventions, and other instructions will result in a deduction of marks.
- Share the GitHub Repository link.
- Share the Live Deployment link.
- Include a README file with clear instructions on how to run the application locally.
- GitHub Repository URL (Server): https://github.com/Apollo-Level2-Web-Dev ( There is no private repository for this assignment,you can use your repository)
- Live Server Link: https://web.programming-hero.com/
- 60 marks: May 22, 2024, 11:59 PM
- 50 marks: May 23, 2023, 11:59 PM
- 30 marks: After May 23, 11.59PM
