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

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


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

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# Hello react frontend

## 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 Hello react frontend

> This is the frontend of the hello rails react app. It is a simple app that generates a random greeting from [this API](https://github.com/Timbar09/hello-rails-back-end).

## 🛠 Built With

### Tech Stack

Client

Server

Database


### Key Features

- **Display a random greeting**

> The app is able to fetch a random greeting from the API and display it to the user.

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

- A browser (e.g. Firefox)
- An IDE (e.g. [Vususal Studio Code](https://code.visualstudio.com/download))
- [npm](https://nodejs.org/en/)

### Setup

To clone this repository to your desired folder, follow the steps below:

- Use the following commands

```sh
cd my-folder
git clone https://github.com/Timbar09/hello-react-front-end.git
```

### Install

Install this project's dependencies with the following command:

```sh
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run dev
```

(back to top)

## 👥 Authors

| 👤 Author | GitHub | Twitter | LinkedIn |
| :----------- | :--------------------------------------- | :-------------------------------------- | :------------------------------------------------------------ |
| Miles Mosweu | [@Timbar09](https://github.com/Timbar09) | [@Milez09](https://twitter.com/Milez09) | [@miles-mosweu09](https://www.linkedin.com/in/miles-mosweu09) |

(back to top)

## 🔭 Future Features

[ ] **Multilingual Support**

> Implement a feature that enables users to receive greetings in different languages.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project, give it a ⭐️ and let me know what you like in particular.

(back to top)

## 🙏 Acknowledgments

I would like to thank the microverse community for the useful content.

(back to top)

## 📝 License

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

(back to top)