Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xen-HendryZheng authored Aug 10, 2023
1 parent 83c81f5 commit f6f7d31
Showing 1 changed file with 2 additions and 22 deletions.
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,14 @@

This repository contains the backend and frontend setup for the Auction System.

## Live Preview
You can find live preview with the following link:
- Auction System Demo : [d3ryzw9q3nhlvi.cloudfront.net](https://d3ryzw9q3nhlvi.cloudfront.net/login)
- Backend API Doc : [https://jitera-backend.hendryzheng.com/api-docs](https://jitera-backend.hendryzheng.com/api-docs)
- API Endpoint : [https://jitera-backend.hendryzheng.com](https://jitera-backend.hendryzheng.com)

## Infrastructure Setup
The infrastructure setup for this demo is using AWS Environment with the following adoption usage:
- EC2 Instance : To provision the backend node server runs on Dockerized environment
- S3 : To host React Distribution Build Files serves as static HTML
- CloudFront : Content delivery network (CDN) service that helps to distribute static content loaded S3 from behind

## Full Architecture
To understand better about the full architecture of this demo, please look at below diagram
![Diagram](./Docs/Full-Architecture.jpg)
## Backend

The backend consists of a Docker configuration file (`docker-compose.yml`) and a migration script that needs to be run during the first-time setup.
The backend consists of a Docker configuration file (`docker-compose.yml`) and a migration script that needs to be run during the first-tim

## OpenAPI Spec

You can also access the API documentation via Swagger UI here [Jitera Backend API Docs](http://jitera-backend.hendryzheng.com:8080)

## Postman Collection

You can also find postman collection for the API documentation here

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/1200729-5c9ffa3f-99ea-44e0-a984-263efcdcfbd6?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D1200729-5c9ffa3f-99ea-44e0-a984-263efcdcfbd6%26entityType%3Dcollection%26workspaceId%3D38e3f536-18a8-41dc-a12d-35d0dbd0da6e)


### Built With
Expand Down Expand Up @@ -57,4 +37,4 @@ You can find full guide for the frontend setup in the [Frontend Readme](./fronte

## Authors

- [HendryZheng](https://github.com/xen-HendryZheng)
- [HendryZheng](https://github.com/xen-HendryZheng)

0 comments on commit f6f7d31

Please sign in to comment.