https://github.com/amhjadkhan/ecommarce2backend

https://github.com/amhjadkhan/ecommarce2backend

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/amhjadkhan/ecommarce2backend
• Owner: AmhjadKhan
• Created: 2024-05-20T20:32:35.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-23T15:36:47.000Z (5 months ago)
• Last Synced: 2024-11-08T20:12:19.698Z (3 months ago)
• Language: TypeScript
• Size: 105 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ecommerce2backend

- [Live Site](https://ecommerce2-backend.vercel.app/)

api/products

api/orders


## Overview

![VSCode](https://img.shields.io/badge/VSCode-007ACC?logo=visual-studio-code&logoColor=white)

![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)

![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1C?logo=javascript&logoColor=black)

![MongoDB](https://img.shields.io/badge/MongoDB-47A248?logo=mongodb&logoColor=white)

![Mongoose](https://img.shields.io/badge/Mongoose-880000?logo=mongoose&logoColor=white)

![Node.js](https://img.shields.io/badge/Node.js-339933?logo=node.js&logoColor=white)

![Express](https://img.shields.io/badge/Express.js-000000?logo=express&logoColor=white)

![Vercel](https://img.shields.io/badge/Vercel-000000?logo=vercel&logoColor=white)

`ecommerce2backend` is a backend project for an e-commerce application. It is built with TypeScript and uses various technologies such as Express, MongoDB, and Zod. This project is designed to handle backend functionalities including APIs, data validation, and more.

## Prerequisites

Before you start, ensure you have the following installed:

- [Node.js](https://nodejs.org/) (v16 or later)

- [npm](https://www.npmjs.com/) (comes with Node.js)

## Getting Started

### 1. Clone the Repository

```bash

git clone https://github.com/AmhjadKhan/Ecommarce2Backend

cd ecommerce2backend

npm install 

```

### here is url

 MONGO_URI=mongodb://localhost:27017/yourdb 

PORT=5000


#### run applicatio

 
npm run start:prod 


### Code Quality and Formatting pretter

npm run lint

npm run lint:fix

npm run prettier

npm run prettier:fix


### script 

start:prod: Starts the server in production mode using nodemon.

build: Compiles TypeScript files to JavaScript.

lint: Lints the code using ESLint.

lint:fix: Fixes linting issues automatically.

prettier: Formats the code with Prettier.

prettier:fix: Fixes formatting issues automatically.

test: Placeholder script for tests (currently not implemented).