Skip to content

Latest commit

 

History

History
114 lines (84 loc) · 6.84 KB

readme.md

File metadata and controls

114 lines (84 loc) · 6.84 KB
Raw

Lottery|Web

Number lottery game - Spring Boot application (backend project)

Lotto|Web is a web port of the well-known number lottery game. The user provides 6 distinct numbers from 1 to 99 and receives a unique coupon identifier. Winning numbers are drawn once per week and all coupons are processed to determine winners. To become a winner user must score at least 3 matched numbers in the lottery. Users can retrieve lottery results anytime using their unique coupon identifier. User coupons generated winning numbers and processed results are kept in a separate database using SpringData with MongoDB. A configured scheduler will run the lottery once per week will and gather all coupons for the current draw date to process them accordingly to the game rules and determine all winners and losers. When processing is done, the user can check his results using his unique coupon ID and get his winner award.

Do you wonder if you can really win something? Here is a surprise for you! My reward for you is to give you the opportunity to do something good - and in this case, you can support the animal shelters!

The main purpose of this project is to learn, learn and learn. Learning by doing. I have explored a couple of different technologies and incorporated them into this project. For a better presentation and my understanding of how the frontend works with the backend, I have created a very simple static landing page, which you can use for playing. This project uses modular monolithic application architecture with elements of hexagonal and microservice architecture. The winning numbers generator has been deployed as an independent microservice. The application is stored in Docker Hub, all modules are containerized - the only thing you need to deploy and run this app by yourself is the docker-compose file and associated MongoDB config js file. For presentation purposes, Lottery|Web has been deployed on the AWS EC2 Linux server. I have hooked my company domain (synerset.com) to mask long and unpleasant AWS DNS addresses, and it should be available at: http://lottery.synerset.com.
UPDATE: 07.04.2023 -> AWS server with landing page was shut down, and it is no longer available.

If you like my project, please hit the star button, thank you!

VERSION: 1.1.0
AUTHOR: PIOTR JAŻDŻYK
LINKEDIN: https://www.linkedin.com/in/pjazdzyk

Specification

  • Spring Boot, web application
  • Modular monolith hexagonal architecture with one module extracted as microservice
  • Facade design pattern
  • NoSQL databases (MongoDB) for coupon and results repositories
  • Good coverage with unit tests, including "happy path" integration tests
  • Controllers tested via mockMvc, winning numbers service was stubbed using WireMock
  • Scheduled lottery run and results processing
  • Full containerization in DOCKER (all modules)
  • Basic landing page provided for presentation purposes
  • Application deployed on AWS Linux EC2 server
  • Netflix-Eureka server used as discovery service
  • NGINX Server used as reverse proxy

Tech

Lotto|Web is developed using following technologies:

Core:
image   image   image   image   image   image  

Testing:
image   image   image  

Front:
image   image   image  

Deployed on:
image  

C3 diagram

The C3 diagram blow presents main application components and module dependencies.
Click on image below to review it more readable size.


Installation and run

Lotto|Web requires Docker to run. Both Winning Numbers microservice and main application (Lottery|Web) are pushed as an images into the Docker Hub. To deploy and run application, just copy anywhere following files:
a) Docker-compose file: compose-prod.yml
b) Mongo-db admin role initialization: init-mongo.js
c) NGINX server configuration file: lottery.conf

All three files must be in the same folder. After that, just run following command, and wait for containers to be pulled up and started.

docker-compose -f compose-prod.yml up

After everything builds and ready, you can test the application using Postman or use a simple landing page I have prepared for testing. Please note, that lottery results are generated each Saturday at 12:00.

Rest-API Endpoints

Application provides two endpoints: for input numbers and results checking. Please follow the specification below:

Service url: [not available online]

ENDPOINT METHOD REQUEST RESPONSE FUNCTION
api/v1/numbers POST JSON BODY (typedNumbers) JSON inputs 6 distinct typed numbers
api/v1/results/{uuid} GET PATH VARIABLE (uuid) JSON retrieves lottery results for ID

License

GNU GENERAL PUBLIC LICENSE V3
Please do not copy-paste my code or parts of my readme without my consent. Or at least put a proper reference to my profile in your readme. Thank you.

Acknowledgments