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

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

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/gleennkar/hello-react-front-end
• Owner: Gleennkar
• License: mit
• Created: 2023-03-03T11:02:38.000Z (over 3 years ago)
• Default Branch: Dev
• Last Pushed: 2023-03-03T14:45:16.000Z (over 3 years ago)
• Last Synced: 2024-05-17T15:25:20.156Z (about 2 years ago)
• Language: JavaScript
• Size: 180 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          





  


  
Hello Rails React - Front End




# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Hello Rails React Front End ](#-hello-rails-react-front-end-)

  - [🛠 Built With ](#-built-with-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Hello Rails React Front End 

**The Hello Rails React Frontend App** is a React web application that displays different kinds of greetings from an API endpoint. It makes use of redux to maintain central store. It is to be interfaced with the [Hello Rails Backend](https://github.com/Gleennkar/hello-rails-react) a Rails Backend application that exposes the API endpoints.

## 🛠 Built With 

  Client

  


    
React.js

  


Client

  


    
Redux

  


### Key Features 

- **React front end**

- **Redux Store**

(back to top)


## 🚀 Live Demo 

> A live demo link will be added soon.

(back to top)


## 💻 Getting Started 

### Prerequisites

In order to run this project you need:

 npm installed

### Setup

Clone this repository to your desired folder:

  git clone https://github.com/Gleennkar/hello-react-front-end.git

  cd hello-react-front-end

### Usage

To run the project, execute the following command:

npm run build - To build the application locally

npm run start - To run the application locally

Run the brower via localhost:3000

### Run tests

To run tests, run the following command:

  npm run test

(back to top)


### 👥 Authors 

**Odette Gleen**

- GitHub: [@Gleennkar](https://github.com/Gleennkar)

- Twitter: [@gleeny24](https://twitter.com/twitterhandle)

- LinkedIn: [@gleeny](https://www.linkedin.com/in/gleeny-nkar-aa3917182)

(back to top)


## 🔭 Future Features 

>

- [ ] **ADD more React Components**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project, please add a ⭐️

(back to top)


## 🙏 Acknowledgments 

Credit to Microverse for the project specification

(back to top)


## 📝 License 

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

(back to top)