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

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


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

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

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

# 📖 Hello Rails API

**Hello react front-end ** is a frontend for a displaying random greetings.

## Backend

The backend was made with rails on ruby and can be found [here](https://github.com/quavo19/hello-rails-back-end)

## 🛠 Built With

### Tech Stack

- ROR
- Postgresql
- Rspec

### Key Features

- **Generate Random Greetings.**
- **It allows users to see each random Greeting.**

(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 the following installed in your local system


  • Ruby

  • Git CLI

  • Github account

### Prerequisites

In order to run this project you need:
- [git](https://git-scm.com/downloads): A tool for managing source code
- [Visual Studio Code](https://code.visualstudio.com/): A source code editor
- Have a working and updated browser
- Have a local version control like git installed on your computer
- A copy of the link of this Repository.
```sh
https://github.com/quavo19/hello-react-front-end.git
```

### Setup
Clone this repository to your desired directory using the command:

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

### Install

Install the required dependencies using the following command:

```sh
npm install
```
### Usage
Run the server using the following command:

```sh
npm start
```
### Run tests
Run this command to fix some CSS linters error
```sh
npx stylelint "**/*.{css,scss}" --fix
```

Run this command to fix some JavaScript linters error
```sh
npx eslint . --fix
```

(back to top)

## 👥 Author

👤 **Akite Donald**

- GitHub: [@githubhandle](https://github.com/quavo19)
- Twitter: [@twitterhandle](https://twitter.com/DonaldAkite)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/donald-akite-299a31222/)

(back to top)

## 🔭 Future Features

- [ ] **[Style the components]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please leave a STAR to the [Github repo](https://github.com/quavo19/
hello-react-front-end/)

(back to top)

## 🙏 Acknowledgments

I would like to appreciate [Microverse](https://www.microverse.org/) for providing the learning resources for this exercise.

(back to top)

## 📝 License

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

(back to top)