https://github.com/kendoriddy/hello-rails-react

https://github.com/kendoriddy/hello-rails-react

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kendoriddy/hello-rails-react
• Owner: kendoriddy
• Created: 2023-01-02T20:18:17.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-03T08:17:03.000Z (about 2 years ago)
• Last Synced: 2024-10-19T03:35:38.726Z (3 months ago)
• Language: Ruby
• Size: 267 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  
Hello Rails React



# 📗 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)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 Hello Rails React 

**Hello Rails React** is a simple web app that combines functionalities of Ruby on Rails and React. It allows users to get a random greeting from the backend API.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

    
Redux Toolkit

  


  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

- **It allows a user to get random greeting**

(back to top)


## 🚀 Live Demo 

- Coming soon

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

- Ruby development environment

- Rails

- Node

- npm or yarn

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:kendoriddy/hello-rails-react.git

```

### Install

Install this project with:

```sh

  cd hello-rails-react

  bundle install

  yarn install || npm install

```

### Usage

To run the project, execute the following command:

```sh

  ./bin/dev

```

### Run tests

To run tests, run the following command:

```sh

  rspec

```

### Deployment

You can deploy this project using:

```sh

  git push heroku main

```

(back to top)


## 👥 Author 

👤 **Kehinde Ridwan Onifade**

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

- Twitter: [@RideOnOne09](https://twitter.com/rideonone09)

- LinkedIn: [Kehinde Ridwan Onifade](https://www.linkedin.com/in/kehindeonifade)

(back to top)


## 🔭 Future Features 

- [ ] **It will allow users to record their greeting**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project you can give me a star.

(back to top)


## 🙏 Acknowledgments 

I would like to thank the Microverse curriculum. 

(back to top)


## 📝 License 

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

(back to top)