project_title

Flight Schedule - React Case study
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This sample React application was developed to showcase skills and knowledge on React, ES6, Webpack, Accessbility, Responsive design, CSS preprocessors, Unit tesing, Snapshot Testing (Jest & React Test Renderer), Functional testing (RTL), Component reuse (Composition, Atomic), HOC & Documentation (React Styleguidist, ReadME.md).

Built With

This section lists major tool, library and frameworks that were used to built this project.

• [React]
• [Scss]
• [Webpack]
• [React Test Renderer]
• [Jest]
• [RTL]
• [Nvda]
• [React Styleguidist]

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Following tool and software you need to be able to enhance this project.

• [Node >= 12.0.0]
• [NPM]
• [NVDA]

Installation

1. Clone the repo

   git clone https://github.com/pankajslingwal/pankajslingwal.github.io
   

2. Install NPM packages

   npm install
   

3. Build Application

   npm run build
   

4. Run Application locally

   npm run start
   

5. Run Snapshot test and Functional test

   npm run test
   

6. See code documentation on https://localhost:6060/

   npm run styleguide
   

Usage

_For more examples, please refer to the DEMO

StyleGuide (Documentation)

Test Report

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 learn, inspire, and create. Any contributions you make are greatly appreciated.

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

Pankaj Singh - pankajslingwal@gmail.com

Project Link: https://github.com/pankajslingwal/pankajslingwal.github.io