/hcpairing-frontend

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

HCPairing

An effective consultant assisting in overcoming obstacles with proven results and policies under the struggling periods.
Explore the services »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

TBD

Built With

The project is mainly built with the following well-known frameworks and libraires.

Getting Started

Besides using the published version, you can compile your own and make pull requests if you think this project can be better!

Prerequisites

Version
Node.js v14.17.0
Npm v6.14.13
React v17.0.2
TypeScript v4.3.2
Redux v7.2.4
Material-UI v4.11.4

Step one - Clone the repo

git clone https://github.com/RainrainWu/hcpairing-frontend.git

Step two - Install dependencies

npm install

Step three - Build

npm run build

The code will be generated in build/ directory

Step four - Host with http-server

npx http-server ./build -p [port]

Be sure that you have already installed npx through npm install -g npx.

Usage

TBD

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please follow the instructions below to start contributing to our project:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Acknowledgements