{"id":25951082,"url":"https://github.com/kledenai/ecommerce-api","last_synced_at":"2026-05-28T01:32:14.471Z","repository":{"id":279548058,"uuid":"939125532","full_name":"Kledenai/ecommerce-api","owner":"Kledenai","description":"A scalable and high-performance e-commerce API built with NestJS, TypeScript, and PostgreSQL. Designed for modularity, security, and efficiency, featuring JWT authentication and Prisma ORM","archived":false,"fork":false,"pushed_at":"2025-03-05T11:47:58.000Z","size":665,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T12:27:48.227Z","etag":null,"topics":["api","authentication","backend","ecommerce","jwt","nestjs","postgresql","prisma","scalable","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kledenai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-26T03:08:34.000Z","updated_at":"2025-03-05T11:48:02.000Z","dependencies_parsed_at":"2025-02-26T06:37:23.705Z","dependency_job_id":null,"html_url":"https://github.com/Kledenai/ecommerce-api","commit_stats":null,"previous_names":["kledenai/ecommerce-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Kledenai/ecommerce-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kledenai%2Fecommerce-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kledenai%2Fecommerce-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kledenai%2Fecommerce-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kledenai%2Fecommerce-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kledenai","download_url":"https://codeload.github.com/Kledenai/ecommerce-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kledenai%2Fecommerce-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33590884,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","authentication","backend","ecommerce","jwt","nestjs","postgresql","prisma","scalable","typescript"],"created_at":"2025-03-04T13:41:12.293Z","updated_at":"2026-05-28T01:32:14.464Z","avatar_url":"https://github.com/Kledenai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo-small.svg\" width=\"120\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Ecommerce API\n\nA scalable and high-performance e-commerce API built with NestJS, TypeScript, and PostgreSQL. Designed for modularity, security, and efficiency, featuring JWT authentication and Prisma ORM.\n\n## Table of Contents\n\n- [Features](#features)\n- [Technologies Used](#technologies-used)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n  - [Database Setup](#database-setup)\n  - [Environment Variables](#environment-variables)\n  - [Running the Application](#running-the-application)\n  - [Running Tests](#running-tests)\n- [License](#license)\n\n## Features\n\n- Product \u0026 category management\n- User authentication \u0026 role-based access (JWT, OAuth)\n- Shopping cart \u0026 checkout (multi-payment support)\n- Order tracking \u0026 real-time notifications\n- Inventory management \u0026 webhook integrations\n\n## Technologies Used\n\n- **NestJS**: A progressive Node.js framework for building efficient and scalable server-side applications.\n- **TypeScript**: A statically typed superset of JavaScript.\n- **PostgreSQL**: A powerful, open-source object-relational database system.\n- **Prisma ORM**: Next-generation ORM for Node.js and TypeScript.\n- **JWT**: JSON Web Tokens for secure authentication.\n- **Docker**: Containerization platform for consistent development and deployment environments.\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have the following installed:\n\n- [Node.js](https://nodejs.org/) (version 14.x or higher)\n- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)\n- [Docker](https://www.docker.com/) (optional, for containerized PostgreSQL setup)\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/Kledenai/ecommerce-api.git\n   cd ecommerce-api\n   ```\n\n2. **Install dependencies:**\n\n   Using npm:\n\n   ```bash\n   npm install\n   ```\n\n   Or using yarn:\n\n   ```bash\n   yarn install\n   ```\n\n### Database Setup\n\nThe application requires a PostgreSQL database. You can set it up in two ways:\n\n1. **Using Docker (Recommended):**\n\n   Utilize the [docker-postgres](https://github.com/Kledenai/docker-postgres) repository to quickly set up a PostgreSQL instance using Docker.\n\n   - **Clone the docker-postgres repository:**\n\n     ```bash\n     git clone https://github.com/Kledenai/docker-postgres.git\n     cd docker-postgres\n     ```\n\n   - **Start the PostgreSQL container:**\n\n     ```bash\n     docker-compose up -d\n     ```\n\n   This will set up a PostgreSQL database accessible at `localhost:5432`.\n\n2. **Manual Setup:**\n\n   Alternatively, install PostgreSQL manually on your system and create a new database.\n\n### Environment Variables\n\nCreate a `.env` file in the root directory of the project and add the following environment variables:\n\n```env\nDATABASE_URL=\"postgresql://\u003cusername\u003e:\u003cpassword\u003e@localhost:5432/\u003cdatabase_name\u003e?schema=public\"\nJWT_SECRET=\"\u003cyour_jwt_secret\u003e\"\nAPP_URL=\"http://localhost:3000\"\n```\n\nReplace `\u003cusername\u003e`, `\u003cpassword\u003e`, and `\u003cdatabase_name\u003e` with your PostgreSQL credentials and desired database name.\n\n### Running the Application\n\n1. **Generate Prisma client:**\n\n   ```bash\n   npx prisma generate\n   ```\n\n2. **Apply database migrations:**\n\n   ```bash\n   npx prisma migrate deploy\n   ```\n\n3. **Start the application:**\n\n   Using npm:\n\n   ```bash\n   npm run start:dev\n   ```\n\n   Or using yarn:\n\n   ```bash\n   yarn start:dev\n   ```\n\n   The API will be running at `http://localhost:3000`.\n\n### Running Tests\n\nTo execute the test suite:\n\nUsing npm:\n\n```bash\nnpm run test\n```\n\nOr using yarn:\n\n```bash\nyarn test\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkledenai%2Fecommerce-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkledenai%2Fecommerce-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkledenai%2Fecommerce-api/lists"}