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

https://github.com/tsheporamantso/hello-react-front-end

This is a React Application that render random greetings from Rails API application
https://github.com/tsheporamantso/hello-react-front-end

Last synced: 7 months ago
JSON representation

This is a React Application that render random greetings from Rails API application

Awesome Lists containing this project

README

          

Random GreetingsπŸ‘‹

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [πŸ“ License](#license)

# πŸ“– Random Greetings

**Random Greetings** This application generates random greeting messages on click of button, built with React fetch data from Rails back-end App.

## πŸ›  Built With

- **React and Redux**
- **Components**
- **JSX**
- **CSS**

### Tech Stack

React

Node js

### Key Features

- **React Components**
- **Rails API**
- **Random Greetings**
- **Redux**

(back to top)

## πŸš€ Live Demo

- [Link](https://github.com/tsheporamantso/hello-rails-back-end/pull/1) to Hello-Rails-Back-End Application

(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:

- Node.js in your computer
- IDE(e.g.: VScode,...)
- Terminal

### Setup

Clone this repository to your desired folder:

```sh
mkdir your-prefered-folder-name
git clone git@github.com:tsheporamantso/hello-react-front-end.git
```

### Install

Install this project with:

```sh
cd hello-react-front-end
npm install or npm i
```

### Usage

To run the project, execute the following command:
run the result on the terminal through:

```sh
npm start or yarn start
```

### Run tests

To run tests, execute the following command on the terminal

```sh
npm test
```

### Deployment

Not deployed

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Gladwin Tshepo Ramantso**

- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)

(back to top)

## πŸ”­ Future Features

- [ ] **Improve Stylings**
- [ ] **Add User Authentication**
- [ ] **Add More Greetings in various languages**
- [ ] **Add NavBar and Footer components**
- [ ] **Add bootstrap styles**
- [ ] **Deploy**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please give a star on [github](https://github.com/tsheporamantso) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).

(back to top)

## πŸ™ Acknowledgments

I would like to thank:

- [ ] **Microverse and all the staff**
- [ ] **Microverse Communinity**
- [ ] **Thanks to my coding Partners**
- [ ] **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- [ ] **Thanks to Code Reviewers**

(back to top)

## πŸ“ License

This project is [MIT](https://github.com/tsheporamantso/hello-react-front-end/blob/a8709d77bfe2c17b3b179c1ce770f23a100d94dc/LICENSE) licensed.

(back to top)