Table of Contents

• 👋 Greeting App
  • 🧰 Tech Stack
  • ✨ Key Features
  • 📘 Getting Started
    • 📋 Prerequisites
    • 📂 Setup
    • 📥 Installation
    • 💾 Database
    • 📦 Build
    • 💻 Usage
  • 👨‍🚀 Author
  • 🎯 Future Features
  • 🤝 Contribution
  • 💖 Show Your Support
  • 🙏 Acknowledgements
  • 📜 License

👋 Greeting App

The Greeting App is a simple web application built to demonstrate the implementation of a connection between a Ruby on Rails back-end and a React front-end. It generates random greetings and serves as a learning tool for understanding the integration between these two 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 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
• Rails 7.0.4 or higher
• PostgreSQL 15.2 or higher

📂 Setup

Clone this repository to your desired foler.

cd my-project
git clone git@github.com:IndieCoderMM/hello-rails-react.git .

📥 Installation

Install the required gems with:

bundle install

Install node dependencies with:

npm install

💾 Database

Create the databases and run migrations with:

rails db:create
rails db:migrate

To load the sample data, run:

rails db:seed

📦 Build

Build the front-end assets with:

npm run build

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

npm run watch

💻 Usage

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

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.

Hein Thant

(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 licensed.

(back to top)