Amit/mui-demo-project
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Tamojit Biswas 2024-08-07 19:37:29 +05:30
parent 0a70f5e10a
commit bf121c9dfa
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.env.local Normal file
View File

@ -0,0 +1 @@
NEXT_PUBLIC_API_URL= https://dummyjson.com

3
.gitignore vendored
View File

@ -25,9 +25,6 @@ npm-debug.log*
yarn-debug.log* yarn-debug.log*
yarn-error.log* yarn-error.log*
# local env files
.env*.local
# vercel # vercel
.vercel .vercel

6
README.md
View File

@ -45,7 +45,6 @@ You can start editing the page by modifying app/page.tsx. The page auto-updates
Project Structure Project Structure
Login: Navigate to the login page to authenticate users. Login: Navigate to the login page to authenticate users.
Signup: Navigate to the signup page to register new users.
Table Data: The home page fetches and displays product data from Dummy JSON. Table Data: The home page fetches and displays product data from Dummy JSON.
Review Modal: Click the "View Reviews" button in any table row to open a modal displaying the product reviews. Review Modal: Click the "View Reviews" button in any table row to open a modal displaying the product reviews.
API API
@ -53,9 +52,12 @@ This project uses the Dummy JSON API to fetch product data. The data is displaye
Components Components
Login Component: Handles user login functionality. Login Component: Handles user login functionality.
Signup Component: Handles user registration functionality.
Table Component: Displays product data in a table format. Table Component: Displays product data in a table format.
Review Modal Component: Displays product reviews in a modal when the "View Reviews" button is clicked. Review Modal Component: Displays product reviews in a modal when the "View Reviews" button is clicked.
.env
As there is no secret key in the .env file, that's why we push it into the repository, otherwire we follow the best practice.
Contributing Contributing
If you would like to contribute to this project, please fork the repository and submit a pull request. If you would like to contribute to this project, please fork the repository and submit a pull request.