From 57d767ec6c637bb08f5c9a045e2aeafb2a52e0bb Mon Sep 17 00:00:00 2001 From: realtradam Date: Thu, 27 Jun 2024 15:34:03 -0400 Subject: update readmes --- rails-backend/README.md | 10 ---------- react-frontend/README.md | 30 ------------------------------ readme.mdown | 8 ++++++++ 3 files changed, 8 insertions(+), 40 deletions(-) delete mode 100644 rails-backend/README.md delete mode 100644 react-frontend/README.md create mode 100644 readme.mdown diff --git a/rails-backend/README.md b/rails-backend/README.md deleted file mode 100644 index 85de49a..0000000 --- a/rails-backend/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Game Holster - -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. - -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. - -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. diff --git a/react-frontend/README.md b/react-frontend/README.md deleted file mode 100644 index 0d6babe..0000000 --- a/react-frontend/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} -``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list diff --git a/readme.mdown b/readme.mdown new file mode 100644 index 0000000..a5b4195 --- /dev/null +++ b/readme.mdown @@ -0,0 +1,8 @@ +# Game Holster + +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. + +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. -- cgit v1.2.3