Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
renebrandel committed May 5, 2024
1 parent 2cb7e40 commit e12861d
Showing 1 changed file with 39 additions and 21 deletions.
60 changes: 39 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,48 @@
# React + TypeScript + Vite
## AWS Amplify Fullstack Realtime Social Room Demo

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
A React and Vite app using AWS Amplify to build a realtime game with generative AI, auth, data, storage, and serverless functions

Currently, two official plugins are available:
## Getting Started
### Clone repo

- [@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
```
git clone https://github.com/aws-samples/amplify-social-room.git
cd amplify-social-room
```

### Install the packages

```
npm i
```

## Expanding the ESLint configuration
### Initiate a cloud sandbox environment

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:
npx ampx sandbox
```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
### Run the App

```
npm run dev
```



## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This library is licensed under the MIT-0 License. See the LICENSE file.

0 comments on commit e12861d

Please sign in to comment.