Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cpshahan authored Apr 23, 2024
1 parent 25ec2ca commit 938e7c8
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
# GameMicroService
### A Team Bobby Project
# APIGateway
### A Team [Redacted] Project
### Members:
> Isaac Camacho, Richard Cashion, Dylan Cowell, Thomas Foreman,
> Dionte Jones, Matt Justis, Jacob Klucher, Dylan Lynch,
> Caleb Rains, Chris Seals, Kyle Wittman
> Kurt Brewer, Josh Rucevice, Charlie Shahan, Ethan Webb, Ethan Hensley, Patrick Vergason, Bryson Brandon
#### CSCI 4350
#### Fall 2023, East Tennessee State University
#### Spring 2024, East Tennessee State University

### Overview:
This is a microservice that returns game info in JSON format to the [BOBBY Project](https://github.com/chrisseals98/BOBBY).
This is the API Gateway that requests and queries from the main website, routed through a single entry-point to the [[Redacted] Project Tetris, Snake, and Pong].

### Project Structure:
* The application handles HTTP calls in the microController.cs file in the /GameMicroServer/Controllers directory.
* It only handles an HTTP Get call to the path /Micro. So if the application was running locally, you would call [http://localhost/Micro](http://localhost/Micro).
* This application is deployed alongside the BucStop project with docker compose, see [BOBBY Project](https://github.com/chrisseals98/BOBBY) for more details.
* This API Gateway acts as a middle-man to facilitate interaction between the BucStop main site and the Microservice(s).
* This architecture was set up with scalability in mind, and to allow the site to function at full capacity regardless of the number of microservices it employs.

### Help
For more documentation on how to run locally and how to set up deployments, see the google docs below:
* [Running Locally](https://docs.google.com/document/d/1gfUpjZNfqWyv1ohUW1IaS8fOhXp0hOx6tFQVXBADa8Q/edit?usp=sharing)
* [How to Deploy](https://docs.google.com/document/d/1i0edcmvZm_j0zQLYiigNliW39FJuJbmhkxOCCb2NbVs/edit?usp=sharing)
* [UNDER CONSTRUCTION]

0 comments on commit 938e7c8

Please sign in to comment.