Urbanize E-Commerce Backend

Welcome to the backend repository of Urbanize E-Commerce, a powerful and flexible e-commerce platform.

Table of Contents

• About
• Features
• Database design
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
• API Documentation
• Contributing
• License

About

Urbanize E-Commerce Backend is the backend server component of a modern e-commerce platform. It's built with Node.js and TypeScript using Express and TypeORM.

Features

• User authentication and authorization
• Product and category management
• Shopping cart and order processing
• Search and filtering functionality

Database Design

Getting Started

Prerequisites

• Node.js (version 19.8.1)
• PostgreSQL (version 15.4)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/urbanize-backend.git

2. Change directory to the project folder:

   cd urbanize-backend
   

3. Install the project dependencies:

   yarn install
   

Configuration

1. Create a .env file in the project root and configure your environment variables.You can use the .env.example file as a template.

2. Modify the .env file with your own settings:

   Database connection URL

   DATABASE_URL=postgresql://your-username:your-password@your-host:your-port/your-database-name

   JWT secret key

   JWT_SECRET=your-secret-key

Usage

To start the Urbanize E-Commerce Backend, run the following command:

yarn dev