{"id":20135732,"url":"https://github.com/abogadatos/EliteGoods-Ecommerce","last_synced_at":"2025-05-06T19:31:44.491Z","repository":{"id":257912263,"uuid":"841334875","full_name":"abogadatos/EliteGoods-Ecommerce","owner":"abogadatos","description":"Free-to-use API providing essential backend functionality for an e-commerce application, built with NestJS, TypeScript, PostgreSQL as part of the SoyHenry Bootcamp.","archived":false,"fork":false,"pushed_at":"2024-10-30T07:15:13.000Z","size":1891,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-09T04:29:35.933Z","etag":null,"topics":["api-rest","backend","database","nestjs","postgresql","swagger","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abogadatos.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":"2024-08-12T07:45:12.000Z","updated_at":"2024-11-27T18:13:08.000Z","dependencies_parsed_at":"2024-12-09T04:39:49.583Z","dependency_job_id":null,"html_url":"https://github.com/abogadatos/EliteGoods-Ecommerce","commit_stats":null,"previous_names":["nechodev/elitegoods-ecommerce","abogadatos/elitegoods-ecommerce"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abogadatos%2FEliteGoods-Ecommerce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abogadatos%2FEliteGoods-Ecommerce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abogadatos%2FEliteGoods-Ecommerce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abogadatos%2FEliteGoods-Ecommerce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abogadatos","download_url":"https://codeload.github.com/abogadatos/EliteGoods-Ecommerce/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252753446,"owners_count":21798963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-rest","backend","database","nestjs","postgresql","swagger","typescript"],"created_at":"2024-11-13T21:16:19.722Z","updated_at":"2025-05-06T19:31:39.479Z","avatar_url":"https://github.com/abogadatos.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://res.cloudinary.com/dwhejzrua/image/upload/v1729007541/ecc8eb02-058c-4fca-b62a-b2b319b48d6e-removebg-preview_vusplu.png\" width=\"200\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e🌟 Welcome to EliteGoods API 🌟\u003c/h1\u003e\n\u003cp align=\"center\"\u003eA modern, secure, and scalable NestJS-based e-commerce API designed to deliver high performance and ease of use for managing product and user data.\u003c/p\u003e\n\n## 🚀 Overview\n\nThis project is a **NestJS**-powered backend API for **EliteGoods**, a scalable and secure e-commerce platform with features like user authentication, product management, and order processing. The API includes detailed **Swagger** documentation, making it easy for developers to explore and integrate with the endpoints.\n\n## ✨ Key Features\n\n- **RESTful API** with NestJS\n- **User Authentication \u0026 Authorization** (JWT-based)\n- **Product \u0026 Category Management**\n- **Order Management**\n- **Comprehensive Swagger Documentation** 📜\n\n## 🛠 Prerequisites\n\n- **Node.js** and **npm**\n- **PostgreSQL** for database\n- **Thunder Client / Postman** (recommended for API testing)\n\n## 🏗 Installation\n\nTo get started with the project, follow these steps:\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/nechodev/EliteGoods-Ecommerce\n   ```\n2. Navigate to the project directory:\n   ```bash\n   cd EliteGoods-Ecommerce\n   ```\n3. Install the required dependencies:\n   ```bash\n   npm install\n   ```\n\n# 🌍 Environment Setup\n\n## 🌱 Environment Variables\n\nBefore running the application, create a `.env` file in the root directory and populate it with the following variables:\n\n| Variable                | Description                                           | Example Value           |\n| ----------------------- | ----------------------------------------------------- | ----------------------- |\n| `DB_HOST`               | Database host address.                                | `localhost`             |\n| `DB_PORT`               | Database connection port.                             | `5432`                  |\n| `DB_USERNAME`           | Database username.                                    | `postgres`              |\n| `DB_PASSWORD`           | Database password.                                    | `your_password_here`    |\n| `DB_NAME`               | Name of the database to connect to.                   | `your_database_name`    |\n| `CLOUDINARY_CLOUD_NAME` | Cloudinary cloud name for image storage.              | `your_cloud_name`       |\n| `CLOUDINARY_API_KEY`    | Cloudinary API key for accessing Cloudinary services. | `your_api_key`          |\n| `CLOUDINARY_API_SECRET` | Cloudinary API secret for authentication.             | `your_api_secret`       |\n| `JWT_SECRET`            | Secret key for signing JWT tokens.                    | `your_jwt_secret`       |\n| `JWT_EXPIRES_IN`        | Duration for which the JWT token is valid.            | `1h`                    |\n| `AUTH0_SECRET`          | Secret used for Auth0 integration.                    | `your_auth0_secret`     |\n| `AUTH0_AUDIENCE`        | Audience for Auth0 token verification.                | `http://localhost:3000` |\n| `AUTH0_CLIENT_ID`       | Client ID for your Auth0 application.                 | `your_auth0_client_id`  |\n| `AUTH0_BASE_URL`        | Base URL for your Auth0 application.                  | `http://localhost:3000` |\n\n\u003e **Note:** Make sure to replace placeholder values with your actual configuration values.\n\n## 🔥 Running the App\n\nTo start the application:\n\n```\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n\n# production\n$ npm run start:prod\n\n```\n\n## 🧪 Testing\n\nThe application includes tests to ensure reliability and performance.\n\n```\n# unit tests\n$ npm run test\n\n# e2e tests\n$ npm run test:e2e\n\n# test coverage\n$ npm run test:cov\n```\n\n## 📚 API Documentation\n\nNavigate to http://localhost:3000/docs for the full API documentation.\n\n## 🔑 Usage\n\nSign Up / Log In to generate your authentication token.\nAuthenticate by including Authorization: Bearer \u003ctoken\u003e in the header of your requests.\n\n## 💖 Support\n\nContributions are welcome! This project is licensed under the MIT License.\n\n## 🌟 Stay Connected\n\nNestJS Official Website\nTwitter - @nestframework\n\n## 📝 License\n\nThis project is MIT licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabogadatos%2FEliteGoods-Ecommerce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabogadatos%2FEliteGoods-Ecommerce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabogadatos%2FEliteGoods-Ecommerce/lists"}