https://github.com/didikz/edotcommerce
Edotcommerce Prototype built with Nestjs
https://github.com/didikz/edotcommerce
javascript nestjs rest-api
Last synced: 4 months ago
JSON representation
Edotcommerce Prototype built with Nestjs
- Host: GitHub
- URL: https://github.com/didikz/edotcommerce
- Owner: didikz
- Created: 2024-09-09T15:54:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T16:41:49.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T13:35:55.311Z (over 1 year ago)
- Topics: javascript, nestjs, rest-api
- Language: TypeScript
- Homepage:
- Size: 401 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EDOTCOMMERCE API
An API for EDOTCOMMERCE platform. Consists of
+ [x] Authentication API: POST `/v1/auth`
+ [ ] Get Products API: GET `/v1/products`
+ [ ] Get Product detail API: GET `/v1/products/{slug}`
+ [ ] Get Carts API: GET `/v1/carts`
+ [ ] Put Item to Cart: PUT `/v1/carts`
+ [ ] Delete Item from Cart: DELETE `/v1/carts`
+ [ ] Checkout Order: POST `/v1/carts/checkout`
## Entity Relationship Diagram
## Setup & Installations
+ Clone repository
+ Install dependencies `npm install`
+ Run mysql server and create database named `edotcommerce`
+ adjust database configuration by copying env file `cp .env.example .env`
+ Run migration using `npm run migration:run` or import sql file `edotcommerce.sql` to created database
+ Run API with `npm run start:dev`
## API Documentation
### Authentication
Authentication API is used to authenticate users for accessing protected resources in the application.
+ Method: `POST`
+ Endpoint: `/v1/auth`
+ Content-Type: `application/json`
+ Request:
```json
{
"mail_phone": "08123456",
"password": "secret123"
}
```
> + `mail_phone`: string, required, could be phone number or email address
> + `password`: string, required
+ Response success (200)
```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwidXNlcm5hbWUiOiJqb2huZG9lQGdtYWlsLmNvbSIsImlhdCI6MTcyNTgxODQ4MiwiZXhwIjoxNzI1ODIyMDgyfQ.jnf13mRY6S3oD83dCqkLY9hVKRR0ktaEP5cBd0g0NHY"
}
```