Order Management Portal

Order Managment Portal is a React web application built using Dhiwise, Figma design and Square APIs

Order Management Portal is the one that lists out all the orders which are already placed.In other words, all the orders are displayed together at your eyesight.Moreover, oredrs can be sorted alphabetically,according to price and quantity. Thereafter, the selected orders pdf can be generated which can then be shared further for processing.

Table of Contents

• Features
• Screenshots
• Setup
• Version of Technologies
• Folder Structure
• Installed Dependency
• MIT License
• Community

Features

• Login
• List of orders
  • Sorting
  • Alphabetically
  • Based on Price
  • Based on Quantity
• Exports
  • Export as Pdf
  • EXport as CSV
• Logout

Screenshots

Setup

1. Setup React

2. Clone the repository

$ git clone https://github.com/DhiWise/Order-Management-Portal.git
$ cd Order-Management-Portal

Install Dependencies

npm install

Running the App

npm start

3. Get Square API Keys

4. Generate location and orderIds

How to run Order Management Portal?

1. Log into the application with username "[email protected]" and password "mGEGqKcEUOMnInZ".

2. Enter authorization token as mentioned above in the setup in service >> api.js.

3. Enter location Id and Order Ids in service >> api.js obtained on order creation.

Running the storybook

We have detected common components and have generated possible variants of it. To check the documentation of generated common components by integrating storybook, Please follow below steps.

Install and Initializes

 npx storybook init

Run the Storybook

  npm run storybook

Version of Technologies

• git - v2.13 or greater
• NodeJS - 12 || 14
• npm - v6 or greater

Folder Structure

After creation, your project should look like this:

.
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── favicon.ico
│   ├── index.html
│   ├── logo192.png
│   ├── logo512.png
│   ├── manifest.json
│   └── robots.txt
├── README.md
├── src
│   ├── App.js
│   ├── assets
│   │   ├── fonts ---------- Project fonts
│   │   └── images --------- All Project Images
│   ├── components --------- UI and Detected Common Components
│   ├── constants ---------- Project constants, eg: string consts
│   ├── hooks -------------- Helpful Hooks
│   ├── index.js
│   ├── pages -------------- All route pages
│   ├── Routes.js ---------- Routing
│   ├── styles
│   │   ├── index.css ------ Other Global Styles
│   │   └── tailwind.css --- Default Tailwind modules
│   └── util
│       └── index.js ------- Helpful utils
└── tailwind.config.js ----- Entire theme config, colors, fonts etc.

Installed Dependency

The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency. You may install other dependencies (for example, React Router) with npm:

1. @tailwindcss/forms - 0.4.0,
2. @testing-library/jest-dom - ^5.15.1,
3. @testing-library/react - ^11.2.7,
4. @testing-library/user-event" - ^12.8.3,
5. axios - ^0.27.2,
6. jspdf - ^2.29.4,
7. lodash - ^4.17.21,
8. prop-types - ^15.8.1,
9. react - 17.0.2,
10. react-datepicker - ^4.5.0,
11. react-dom - 17.0.2,
12. react-modal - ^3.14.4,
13. react-router-dom - 6.0.2,
14. react-router-hash-link - ^2.4.3,
15. react-scripts - 5.0.0,
16. react-select - ^5.2.1,
17. react-toastify - ^9.0.1,
18. simple-react-hook-form - ^1.0.4,
19. web-vitals - ^2.1.0
20. yup" - ^0.32.11

MIT License

Copyright (c) 2022 DhiWise

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Community