Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gal16v8d/dw1-ui
UI Wiki for Digimon World 1 PS1 videogame
https://github.com/gal16v8d/dw1-ui
bulma msw primereact react react-hotkeys react-i18next react-query typescript vite zustand
Last synced: 3 days ago
JSON representation
UI Wiki for Digimon World 1 PS1 videogame
- Host: GitHub
- URL: https://github.com/gal16v8d/dw1-ui
- Owner: gal16v8d
- Created: 2023-01-16T04:45:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T01:55:07.000Z (about 1 month ago)
- Last Synced: 2024-11-19T02:53:48.354Z (about 1 month ago)
- Topics: bulma, msw, primereact, react, react-hotkeys, react-i18next, react-query, typescript, vite, zustand
- Language: TypeScript
- Homepage: https://dw1-ui.vercel.app
- Size: 5.61 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DW1-UI
This project was bootstrapped with [Vite](https://vitejs.dev/).
Basically, its a really basic UI wiki view for all the data related to Digimon World 1 (1999) PS1 game.
This is still an exploratory WIP (I am feeding the database), so it may get some data updates soon.
This UI consumes a service that currently is available at [Railway](https://railway.app/) (see [DW1-Service](https://github.com/gal16v8d/dw1-svc)) and then stores the data in cache, I am not keeping live the backend due some costs after starter plan is fully consumed, but it can live 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:5175](http://localhost:5175) 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 test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `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.
### Docker
To build the docker image, inside project dir:
```bash
docker build -t gsdd-dw1-ui .
```
Then run using something like:
```bash
docker run -p 5175:5175 -e VITE_API_URL=http://api.example.com -e VITE_APP_VERSION=0.0.1 -e VITE_ENABLE_CRUD=false -e VITE_ENABLE_MOCKS=true gsdd-dw1-ui
```
## List of cool technologies in use here
- [Bulma](https://bulma.io/)
- [Husky](https://typicode.github.io/husky/#/)
- [Msw](https://mswjs.io/)
- [Primereact](https://primereact.org/)
- [React](https://reactjs.org/)
- [React-Hotkeys](https://react-hotkeys-hook.vercel.app/)
- [React-i18next](https://react.i18next.com/)
- [React-Query](https://tanstack.com/query/v4/docs/react/adapters/react-query)
- [Vite](https://vitejs.dev/)
- [Zustand](https://docs.pmnd.rs/zustand/recipes/recipes)
## License
[MIT licensed](LICENSE).
## Stay in touch
- Author - [gal16v8d](https://github.com/gal16v8d)