Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/besufekad-haz/hello-rails-react

The Rails-React App is a straightforward web application designed to showcase the seamless integration between a Ruby on Rails back-end and a React front-end.
https://github.com/besufekad-haz/hello-rails-react

Last synced: 16 days ago
JSON representation

The Rails-React App is a straightforward web application designed to showcase the seamless integration between a Ruby on Rails back-end and a React front-end.

Awesome Lists containing this project

README

        


Table of Contents

- [👋 Rails-React-App](#-Rails-React-app)
- [🧰 Tech Stack ](#-tech-stack--)
- [✨ Key Features ](#-key-features--)
- [📘 Getting Started ](#-getting-started--)
- [📋 Prerequisites](#-prerequisites)
- [📂 Setup](#-setup)
- [📥 Installation](#-installation)
- [💾 Database](#-database)
- [📦 Build](#-build)
- [💻 Usage](#-usage)
- [👨‍🚀 Author ](#-author--)
- [🎯 Future Features ](#-future-features--)
- [🤝 Contribution ](#-contribution--)
- [💖 Show Your Support ](#-show-your-support--)
- [🙏 Acknowledgements](#-acknowledgements)
- [📜 License ](#-license-)

# 👋 Rails-React App

The Rails-React App is a straightforward web application designed to showcase the seamless integration between a Ruby on Rails back-end and a React front-end. It generates random greetings and serves as an educational resource for gaining insights into the connection between these two powerful technologies.

(back to top)

## 🧰 Tech Stack

- Front end: React
- State management: Redux Toolkit
- Back end: Ruby on Rails
- Database: PostgreSQL

(back to top)

## ✨ Key Features

- Random Greetings: The app generates a random greeting each time it is loaded
- React and Redux: The front end is built using React, and API calls are made using Redux
- API: The back end is built using Ruby on Rails, creating an API endpoint to generate a random greeting message.

(back to top)

## 📘 Getting Started

To run this project locally, you'll need to follow these steps.

### 📋 Prerequisites

Make sure you have the following installed on your machine:
- [Ruby 3.1.3 or higher](https://www.ruby-lang.org/en/)
- [Rails 7.0.4 or higher](https://rubyonrails.org/)
- [PostgreSQL 15.2 or higher](https://www.postgresql.org/)

### 📂 Setup

Clone this repository to your desired foler.

```sh
cd my-project
git clone [email protected]:Besufekad-HAZ/hello-rails-react.git
```

### 📥 Installation

Install the required gems with:

```sh
bundle install
```

Install node dependencies with:

```sh
npm install
```

### 💾 Database

Create the databases and run migrations with:

```sh
rails db:create
rails db:migrate
```

To load the sample data, run:

```sh
rails db:seed
```

### 📦 Build

Build the front-end assets with:

```sh
npm run build
```

You can also set it to *watch mode* which automatically build after every changes. To start the *watch mode*, use:

```sh
npm run watch
```

### 💻 Usage

After building the assets, run the development server with the following command:

```sh
rails server
```

(back to top)

## 👨‍🚀 Author

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

(back to top)

## 🎯 Future Features

- [ ] Add more endpoints

(back to top)

## 🤝 Contribution

Contributions, issues, and feature requests are welcome!

(back to top)

## 💖 Show Your Support

If you like this project, please consider giving it a ⭐.

(back to top)

## 🙏 Acknowledgements

I would like to thank all code reviewers for making this project better.

(back to top)

## 📜 License

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

(back to top)