An open API service indexing awesome lists of open source software.

https://github.com/yacoubou-seidou/hello-react-front-end


https://github.com/yacoubou-seidou/hello-react-front-end

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

Hello react front-end

## Server

[Link to back-end](https://github.com/Yacoubou-seidou/hello-rails-back-end)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[hello-react-front-end\] ](#-hello-react-front-end-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Build for production](#build-for-production)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [hello-react-front-end]

**[hello-react-front-end]** It is a front end app for display greeting fetch from a backend server.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- [x] Created a web app using react-redux
- [x] Display Greeting
- [x] Used React and Redux technology.
- [x] Used `axios` to fetch data from the API.
- [x] Used store, actions and reducers in React.
- [x] Used React hooks.

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- Text editor , example vscode
- Navigator, example chrome
- Node.js in your computer

### Setup

Clone this repository to your desired folder:

```
git clone https://github.com/Yacoubou-seidou/hello-react-front-end.git
cd hello-react-front-end
```

```
also_need_back_end_server:
git clone https://github.com/Yacoubou-seidou/hello-rails-back-end.git
Follow instruction in the readme.md file
```

### Install

Install this project with:

```sh
npm install
```

### Usage

```
1. download the project from clone
2. Install all dependencies using *npm install*
3. Run *npm start*
4. You can see it in the browser
```

### Build for production

```
npm run build
```

### Run tests

- ### Linter Tests

To run tests, run the following command:

To check for html errors run:

```sh
npx hint .
```

To check for css errors run:

```sh
npx stylelint "**/*.{css,scss}"
```

To check for js errors run:

```sh
npx eslint .
```

(back to top)

## 👥 Authors

👤 **Yacoubou Seidou**

- GitHub: [@Yacoubou-seidou](https://github.com/Yacoubou-seidou)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/yacoubou-seidou-chaibou/)

(back to top)

## 🔭 Future Features

- [x] Add test to the project using jest
- [x] Add the live demo for the project
- [x] Add Styles

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issue page](https://github.com/Yacoubou-seidou/hello-react-front-end/issues).

(back to top)

## ⭐️ Show your support

If you like this feel free to follow me on github and give this project a star.

(back to top)

## 🙏 Acknowledgments

- Thanks to the Microverse team for the great curriculum.

(back to top)


(back to top)

## 📝 License

This project is [MIT](./LICENSE.md) licensed.

(back to top)