Skip to content

Latest commit

 

History

History

web

This project was bootstrapped with Create React App.

Prerequisites

Install Node 10 and Yarn.

Development

In the project directory, you can run:

yarn

This will install all of the dependencies you need.

yarn start

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

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn lint

Lints and checks TypeScript code for formatting problems according to Google Typescript Style, and lints CSS in styled components using stylelint with the standard config rules.

yarn lint:code

Lints and checks TypeScript code for formatting problems according to Google Typescript Style only.

yarn lint:css

Lints CSS in styled components using stylelint with the standard config rules.

yarn fix

Automatically fixes formatting and linting problems (if possible) according to Google Typescript Style.

yarn clean

Removes output files.

yarn typecheck

Runs typechecking with the TypeScript compiler without emitting JS files.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn 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.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Project Structure

├── src
│   ├── assets                     # Project assets, eg. icons, illustrations
│   ├── components
│   │   ├── common                 # Reusable components
│   │   ├── customer               # Customer related pages and its components
│   │   └── merchant               # Merchant related pages and its components
│   ├── App.tsx                    # App entry point
│   ├── index.tsx                  # JavaScript entry point
│   ├── Routes.tsx                 # App routing component
│   └── serviceWorker.ts
└── public                         # Contains the HTML template of our app

Component Folder Structure

Folders customer/ and merchant/ will have the following folder structure:

└── my-page
    ├── index.tsx                   # Entry point of the page
    ├── MyPageComponentA.tsx        # Components that are only used for that page
    └── ...

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.