shiv_not-found-page-1/README.md

This is the not found page component, that can be directly used with ReactJS.

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

# Not Found Page

> This is a simple not-found page that is built to be used with ReactJS

## Prerequisites

This project requires NodeJS (version 8 or later) and NPM.
[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
To make sure you have them available on your machine,
try running the following command.

```sh
$ npm -v && node -v
8.19.4
16.20.0
```

## Table of contents

- [Project Name](#project-name)
  - [Prerequisites](#prerequisites)
  - [Table of contents](#table-of-contents)
  - [Getting Started](#getting-started)
  - [Installation](#installation)
  - [Usage](#usage)
    - [Serving the app](#serving-the-app)
  - [Built With](#built-with)
  - [Versioning](#versioning)
  - [Authors](#authors)
  - [License](#license)

## Getting Started

Just create a React app and start using this package with the installation commands

## Installation

**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)

Start with installing the package using npm:

```sh
npm install shiv_not-found-page-1
```

Or if you prefer using Yarn:

```sh
$ yarn add shiv_not-found-page-1
```

## Usage

### Serving the app

#### Options

`props`

| Props | Type | Example |
| --- | --- | --- |
| errorCode | 'string' | "403" |
| text | 'string' | "Forbidden" |
| backLink | 'string' | "/profile" |
| homeLink | 'string' | "/home" |

If present, the request will be performed as soon as the component is mounted

Example:

```jsx
import NotFound from shiv_not-found-page-1'

function App() {
  const notFoundObj = {
    errorCode: '501',
    text: 'Internal server error',
    backLink: '/',
    homeLink: '/',
  }

  return (
    <div className="App">
      <NotFound
        errorCode={notFoundObj.errorCode}
        text={notFoundObj.text}
        backLink={notFoundObj.backLink}
        homeLink={notFoundObj.homeLink}
      />
    </div>
  )
}

export default App

```

## Built With

* ReactJS 
* NodeJS

## Versioning

* GitHub 
* GitLab

## Authors

* **Shiv Shakti Bharti** - *Initial work* - [Shiv-git1]https://github.com/Shiv-git1

## License
ISC