Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JarrodMalkovic/auction-website
🛒 A full-stack real-time auction website built using a microservices architecture
https://github.com/JarrodMalkovic/auction-website
auction-website ingress-nginx kubernetes microservices microservices-architecture microservices-demo stripe
Last synced: 3 months ago
JSON representation
🛒 A full-stack real-time auction website built using a microservices architecture
- Host: GitHub
- URL: https://github.com/JarrodMalkovic/auction-website
- Owner: JarrodMalkovic
- License: unlicense
- Created: 2021-02-18T08:37:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-20T11:42:04.000Z (over 3 years ago)
- Last Synced: 2024-04-30T12:36:50.708Z (7 months ago)
- Topics: auction-website, ingress-nginx, kubernetes, microservices, microservices-architecture, microservices-demo, stripe
- Language: TypeScript
- Homepage:
- Size: 1 MB
- Stars: 118
- Watchers: 6
- Forks: 55
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Full Stack Auction Website
## 📝 Table of contents
- [Features](#-features)
- [Architecture](#-architecture)
- [Screenshots](#-screenshots)
- [Technologies](#-technologies)
- [About this Project](#-about-this-project)
- [Local Development](#-local-development)
- [License](#-license)
## ✨ Features
- Real-time bidding on auction listings between users using Socket.IO
- Server-Side Rendering using React and Next.js
- Styled frontend using Tailwind CSS with Emotion Styled Components
- Automated testing suites for each microservice
- Handles payments using the Stripe API
- Shares common code among services using a custom [npm package](./common)
## 🏛️ Architecture
### Diagram
### Overview of services
| Service | Technologies | Description |
| ----------------------------------- | -------------------------- | ----------------------- |
| [Auth](./services/auth) | TypeScript, MySQL | Handles user regristration, logging in, signing out and resetting users passwords |
| [Bids](./services/bid) | TypeScript, MySQL | Handles users placing bids on auction listings and allows for real-time bidding using Socket.io |
| [Email](./services/email) | TypeScript | Allows other services to send emails to users by publishing EmailCreated events |
| [Expiration](./services/bid) | TypeScript, Redis | Expires auction listings once they have ran out of time remaining on the listing |
| [Frontend](./services/frontend) | TypeScript, React, Next.js | Handles serving the website to the user utilizing Server Side Rendering using React with Next.js |
| [Listings](./services/listings) | TypeScript, MySQL | Allows users to create and delete auction listings |
| [Payments](./services/payments) | TypeScript, MySQL | Allows users to pay for auction listings they have won |
| [Profile](./services/profile) | TypeScript, MySQL | Allows users to get a users profile or update their own |
## 📸 Screenshots
## 💻 Technologies
### Back-end
- [Node.js](https://nodejs.org/en/) - Runtime environment for JS
- [Express.js](https://expressjs.com/) - Node.js framework, makes process of building APIs easier & faster
- [MySQL](https://www.mysql.com/) - An open-source relational database management system
- [Sequelize](https://sequelize.org/) - A promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server
- [Cloudinary](https://cloudinary.com/) - For image uploading and manipulation
- [Docker](https://www.docker.com/) - A platform for developing, shippinh and running applications
- [Kubernetes](https://kubernetes.io/) - An open-source system for automating deployment, scaling, and management of containerized applications
- [Ingress NGINX](https://kubernetes.github.io/ingress-nginx/) - NGINX Ingress Controller for Kubernetes
- [Skaffold](https://skaffold.dev/) - Handles the workflow for building, pushing and deploying applications
- [Stripe](https://stripe.com/) - Online payment processing for internet businesses
- [Jest](https://jestjs.io/) - A JavaScript testing framework
### Front-end
- [ReactJS](https://reactjs.org/) - Frontend framework
- [Next.js](https://nextjs.org/) - React framework that enables server-side rendering
- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework
- [Emotion](https://emotion.sh/) - CSS-in-JS library designed for high performance style composition
- [Formik](https://formik.org/) - React framework for building forms
- [Yup](https://github.com/jquense/yup) - A form validation library
## 📙 About this Project
This project is a rewrite of a previous monolithic auction website I wrote. The repository for my monolithic auction website can be found [here.](https://github.com/jarrodmalkovic/auction-website-monolith) The purpose of this rewrite was to gain experience utilizing a microservices architecture after completing [Stephen Griders course on Microservices](https://www.udemy.com/course/microservices-with-node-js-and-react/).
## 🚀 Local Development
### Clone the respository locally
```bash
git clone https://github.com/jarrodmalkovic/auction-website.git
```
### Edit your hosts file
- Add the following line to your hosts file (https://phoenixnap.com/kb/how-to-edit-hosts-file-in-windows-mac-or-linux)
```bash
127.0.0.1 auctionweb.site
```
### Install ingress-nginx
```bash
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.44.0/deploy/static/provider/cloud/deploy.yaml
```
### Create the required kubernetes secrets
- Create the JWT_KEY secret
```bash
kubectl create secret generic jwt-secret --from-literal=JWT_KEY=
```
- Create the MYSQL_ROOT_PASSWORD secret
```bash
kubectl create secret generic mysql-root-password-secret --from-literal=MYSQL_ROOT_PASSWORD=
```
- Create the EMAIL secret
```bash
kubectl create secret generic email-secret --from-literal=EMAIL=
```
- Create the EMAIL_PASSWORD secret
```bash
kubectl create secret generic email-password-secret --from-literal=EMAIL_PASSWORD=
```
- Create the STRIPE_KEY secret
```bash
kubectl create secret generic stripe-secret --from-literal=STRIPE_KEY=
```
- Create the CLOUDINARY_API_KEY secret
```bash
kubectl create secret generic cloudinary-api-key-secret --from-literal=CLOUDINARY_API_KEY=
```
- Create the CLOUDINARY_CLOUD_NAME secret
```bash
kubectl create secret generic cloudinary-cloud-name-secret --from-literal=CLOUDINARY_CLOUD_NAME=
```
- Create the CLOUDINARY_API_SECRET secret
```bash
kubectl create secret generic cloudinary-api-secret-secret --from-literal=CLOUDINARY_API_SECRET=
```
### Start skaffold
```basb
skaffold dev
```
### Open the project in your browser
- The project will now be available locally on the domain auctionweb.site in your browser. If you are using Google Chrome you may have to type "thisisunsafe" while on the page to bypass a security warning
## ⚖️ License
This project is licensed under the Unlicense License