Dreezy305 / Game-app

GAMES APP

This project was bootstrapped with Create React App.

This is a dashboard application that displays data from REST API. In this app, there are user and games menu. The user menu navigates to the user page where user data is dispayed on a table and vice versa.

LIBRARIES

• Material UI
• React Pro Sidebar
• Axios
• React-Query
• Formik
• Dayjs
• XLSX (Sheetjs)

INSTALLATION

• Clone the repository to your local machine.
• Open a terminal window in the project directory.
• Run npm install to install the project dependencies.

USAGE

• Open a terminal window in the project directory.
• Run npm start to start the application.
• The application will be available at http://localhost:3000.

DEPLOYMENT

• The application was hosted via netlify cloud provider
• LIVE URL is: https://games-app-yolo.netlify.app/

USAGE INSTRUCTIONS

Users

• The Users page displays user information such as name, email, address, creation date, phone number and image in a table.
• A user data can be viewed by clicking the "eye" icon under the action column on the table.
• On click of the eye icon navigates to the user page where further info about a particular user can be seen.
• operations like create, edit, delete and filter can be performed on the pages.
• the select comppnent contains a list of options (name, email, gender, address), select an option, type in value in the input field and the data in table will be updated to display the result of the filter
• the pen icon under the actions column pops up a modal, this modal enables a user to edit/update a user data
• the eye icon, navigates a user to a page where further details of the selected user can be viewed
• the bin icon deletes a user data

Games

• The Games page displays user information such as name, game category, creation date, scores, and ratings in a table.
• A game data can be viewed by clicking the "eye" icon under the action column on the table
• On click of the eye icon navigates to the game page where further info about a particular game can be seen
• operations like create, edit, delete and filter can be performed on the pages
• the select comppnent contains a list of options (name, game category and scores), select an option, type in value in the input field and the data in table will be updated to display the result of the filter
• the pen icon under the actions column pops up a modal, this modal enables a user to edit/update a game data
• the eye icon, navigates a user to a page where further details of the selected game can be viewed
• the bin icon deletes a game data

CONTRIBUTING GUIDLINES

• Fork the repository and create a new branch for your changes.
• Submit a pull request with your changes.
• Your pull request will be reviewed by a maintainer and merged if it meets the project's standards.

CONTACT INFORMATION

• If you have any questions or issues with the project, you can contact me at [e-mail]