Skip to content

nathanwkwong/board-game-search-react-dashboard

Repository files navigation

Getting Started with board-game-search-react-dashboard

This project is a SPA built from TypeScript, React.js, React Query, Material UI and Vite.
It connected to Board Game Atlas API and shows board game information.
It is deployed on https://board-game-search-react-dashboard.vercel.app \

To run this project you need a client id from Board Game Atlas API (get it for free after registration). After you get the client id, you need to put it to a .env file at the root folder of the project. The format can be found inside .env.example file.

Available Scripts

In the project directory, you can run:

npm install

Install packages in order to run this project.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

npm run build

Builds the app for production to the build folder.