diff options
| author | realtradam <[email protected]> | 2024-06-24 00:14:03 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2024-06-24 00:14:03 -0400 |
| commit | 8ec0664fe7cf4a34bc5fc1f162c053622a42dd41 (patch) | |
| tree | d2d4873d82962b07246d4c3161374becb5bf7c98 | |
| parent | d45b7447d5029cb849503df10c72c0b7064f6a58 (diff) | |
| download | gameHolster-8ec0664fe7cf4a34bc5fc1f162c053622a42dd41.tar.gz gameHolster-8ec0664fe7cf4a34bc5fc1f162c053622a42dd41.zip | |
update readme
| -rw-r--r-- | README.md | 28 |
1 files changed, 7 insertions, 21 deletions
@@ -1,24 +1,10 @@ -# README +# Game Holster -This README would normally document whatever steps are necessary to get the -application up and running. +Game holster is a full-stack Ruby on Rails and React application for uploading and serving web games made with common game engines such as Unity, Godot, Raylib, and more. -Things you may want to cover: +Currently implemented features in the backend are: +- User authentication: users can log in using GitHub OAuth +- Game Upload: Once a user is logged in they can upload a game which will then belong to them +- Game Serving: Games can be played by users. The games are served under a different domain in order to make XSS attacks impossible in-case a user uploads compromised files. -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +The front-end is temporarily my [personal website](https://malcz.com/games) which is made using React. However I am working on a new React frontend in order to have this application be completely standalone and more accessible. |