https://github.com/basemax/productsgraphqlts
This project is an e-commerce application built with GraphQL and TypeScript using the NestJS framework. It provides various functionalities for managing products, categories, and user authentication. The project includes features such as user registration, login, authentication, logout, product management.
https://github.com/basemax/productsgraphqlts
graphql graphql-ts javascript js nest ts ts-graphql typescript typescript-graphql
Last synced: 19 days ago
JSON representation
This project is an e-commerce application built with GraphQL and TypeScript using the NestJS framework. It provides various functionalities for managing products, categories, and user authentication. The project includes features such as user registration, login, authentication, logout, product management.
- Host: GitHub
- URL: https://github.com/basemax/productsgraphqlts
- Owner: BaseMax
- License: gpl-3.0
- Created: 2023-06-05T16:14:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T19:29:42.000Z (about 1 month ago)
- Last Synced: 2025-05-04T21:45:48.909Z (20 days ago)
- Topics: graphql, graphql-ts, javascript, js, nest, ts, ts-graphql, typescript, typescript-graphql
- Language: TypeScript
- Homepage:
- Size: 493 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# E-Commerce Project with GraphQL and NestJS
This project is an e-commerce application built with GraphQL and TypeScript using the NestJS framework. It provides various functionalities for managing products, categories, and user authentication. The project includes features such as user registration, login, authentication, logout, product management (including creation, editing, deletion, searching, sorting, pagination), category management (including creation, editing, deletion), and role-based access control.
## Prerequisites
Before running the application, ensure that the following prerequisites are met:
- Node.js (version >= 12) is installed on your machine.
- NPM (Node Package Manager) or Yarn is installed.
- MongoDB or any other compatible database is set up and running.
## Installation
Clone the repository:
```bash
git clone https://github.com/BaseMax/ProductsGraphQLTS.git
```
Install the dependencies:
```bash
cd ProductsGraphQLTS
npm install
```
## Configuration
Rename the `.env.example` file to `.env` and update the following configuration variables as per your environment:
```makefile
# Database configuration
DB_HOST=
DB_PORT=
DB_NAME=
# JWT secret key for token generation
JWT_SECRET=
# Admin email and password for initial setup
ADMIN_EMAIL=
ADMIN_PASSWORD=
```
Adjust any other necessary configuration settings based on your requirements.
## Usage
To start the application, run the following command:
```
npm run start
```
This will start the server on the specified port (default is 3000). You can access the GraphQL playground by navigating to http://localhost:3000/graphql in your browser.
## API Endpoints
The API endpoints are defined using GraphQL and can be accessed through the GraphQL playground. Below are the available queries and mutations:
### Authentication
- `register`: Create a new user account.
- `login`: Authenticate a user and generate an access token.
- `logout`: Invalidate the access token and log out the user.
### Products
- `getProducts`: Retrieve a list of products.
- `createProduct`: Create a new product.
- `editProduct`: Update an existing product.
- `deleteProduct`: Delete a product.
- `searchProduct`: Search for products based on a keyword.
- `filterProducts`: Filter products based on specific criteria (e.g., category, price range, etc.).
- `paginateProducts`: Retrieve paginated products based on specified page and limit values.
### Categories
- `createCategory`: Create a new category.
- `editCategory`: Update an existing category.
- `deleteCategory`: Delete a category.
- `getProductsByCategory`: Retrieve all products within a specific category.
### Admin-specific
- `getInactiveProducts`: Retrieve all products that are not yet active.
- `activateProduct`: Activate a product.
- `deactivateProduct`: Deactivate a product.
Note: Certain mutations and queries may require the user to be authenticated and have the appropriate role (e.g., admin) to access them.
## Examples
### Authentication
**Register**
```graphql
mutation {
register(input: {
name: "John Doe",
email: "[email protected]",
password: "password123"
}) {
id
name
email
created
message
}
}
```
**Login**
```graphql
mutation {
login(input: {
email: "[email protected]",
password: "password123"
}) {
accessToken
message
}
}
```
### Products
**Get Products**
```graphql
query {
getProducts {
id
name
price
category {
id
name
}
}
}
```
**Create Product**
```graphql
mutation {
createProduct(input: {
name: "Product Name",
price: 29.99,
categoryId: ""
}) {
id
name
price
category {
id
name
}
}
}
```
**Edit Product**
```graphql
mutation {
editProduct(input: {
id: "",
name: "New Product Name",
price: 39.99
}) {
id
name
price
category {
id
name
}
}
}
```
**Delete Product**
```graphql
mutation {
deleteProduct(id: "")
}
```
**Search Product**
```graphql
query {
searchProduct(keyword: "keyword") {
id
name
price
category {
id
name
}
}
}
```
**Filter Products**
```graphql
query {
filterProducts(categoryId: "", minPrice: 10, maxPrice: 50) {
id
name
price
category {
id
name
}
}
}
```
**Paginate Products**
```graphql
query {
paginateProducts(page: 1, limit: 10) {
totalItems
totalPages
currentPage
products {
id
name
price
category {
id
name
}
}
}
}
```
### Categories
**Create Category**
```graphql
mutation {
createCategory(name: "Category Name") {
id
name
}
}
```
**Edit Category**
```graphql
mutation {
editCategory(id: "", name: "New Category Name") {
id
name
}
}
```
**Delete Category**
```graphql
mutation {
deleteCategory(id: "")
}
```
**Get Products by Category**
```graphql
query {
getProductsByCategory(categoryId: "") {
id
name
price
category {
id
name
}
}
}
```
### Admin-specific
**Get Inactive Products**
```graphql
query {
getInactiveProducts {
id
name
price
category {
id
name
}
}
}
```
**Activate Product**
```graphql
mutation {
activateProduct(id: "") {
id
name
price
category {
id
name
}
}
}
```
**Deactivate Product**
```graphql
mutation {
deactivateProduct(id: "") {
id
name
price
category {
id
name
}
}
}
```
## Authentication and Authorization
User authentication is handled using JWT (JSON Web Tokens). When a user successfully logs in, an access token is generated and returned in the response. This access token should be included in the Authorization header for subsequent requests requiring authentication.
The application implements role-based access control, differentiating between admin and normal users. Admins have additional privileges, such as viewing inactive products.
Copyright 2023, Max Base