Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gal16v8d/pvz-ui
UI Wiki for Plants vs Zombies PC Game
https://github.com/gal16v8d/pvz-ui
material-ui msw mui react react-i18next react-query typescipt typescript vite
Last synced: 11 days ago
JSON representation
UI Wiki for Plants vs Zombies PC Game
- Host: GitHub
- URL: https://github.com/gal16v8d/pvz-ui
- Owner: gal16v8d
- Created: 2023-03-18T03:45:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T01:30:52.000Z (about 2 months ago)
- Last Synced: 2024-11-19T02:38:46.675Z (about 2 months ago)
- Topics: material-ui, msw, mui, react, react-i18next, react-query, typescipt, typescript, vite
- Language: TypeScript
- Homepage: https://pvz-ui.vercel.app/
- Size: 7.29 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PVZ-UI
This project was bootstrapped with [Vite](https://vitejs.dev/).
Basically, its a really basic UI wiki view for all the data related to Plants Vs Zombies PC game.
This is still an exploratory WIP, so it may get some data updates soon.
This UI consumes a python API (see pvz-svc repo) who currently is not alive, since I am checking to deploy the backend service either in Railway or Deta. But UI is alive through a flag that enable mocking using [MSW](https://mswjs.io/). It should be up, but if is not the case, feel free to ping.
## Available Scripts
In the project directory, you can run:
### `npm run dev`
Runs the app in the development mode.\
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
### `npm run generate-api-model`
Generate all the models from swagger docs available in the backend services, it can be upgraded by calling the command again.
### Docker
To build the docker image, inside project dir:
```bash
docker build -t gsdd-pvz-ui .
```
Then run using something like:
```bash
docker run -p 5173:5173 -e VITE_API_URL=http://api.example.com -e VITE_APP_VERSION=0.0.1 -e VITE_ENABLE_MOCKS=true gsdd-pvz-ui
```
## List of cool technologies in use here
- [Msw](https://mswjs.io/)
- [MUI](https://mui.com/material-ui/)
- [React](https://reactjs.org/)
- [React-i18next](https://react.i18next.com/)
- [React-Query](https://tanstack.com/query/v4/docs/react/adapters/react-query)
- [Vite](https://vitejs.dev/)
## License
[MIT licensed](LICENSE).
## Stay in touch
- Author - [gal16v8d](https://github.com/gal16v8d)