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-backend-app

Hello Rails Greeting App is a web app that generates random greetings, showcasing the integration of Ruby on Rails and React. Learn how to combine the scalability of Rails with the efficiency of React and build dynamic web applications
https://github.com/besufekad-haz/hello-rails-backend-app

Last synced: 16 days ago
JSON representation

Hello Rails Greeting App is a web app that generates random greetings, showcasing the integration of Ruby on Rails and React. Learn how to combine the scalability of Rails with the efficiency of React and build dynamic web applications

Awesome Lists containing this project

README

        


Table of Contents

- [👋 Greeting-App](#-Greeting-App)
- [📂 Frontend Repository](#-frontend-repository)
- [🧰 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-)

# 👋 Greeting App (Back-end)

Greeting App: A web app that generates random greetings, showcasing the integration of Ruby on Rails and React. Learn how to combine the scalability of Rails with the efficiency of React and build dynamic web applications

(back to top)

## 📂 Frontend Repository

The frontend repository for the Greeting App can be found at [hello-react-front-end](https://github.com/Besufekad-HAZ/hello-react-front-end-app). It contains the code for the user interface and interacts with the backend server.

(back to top)

## 🧰 Tech Stack

- 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
- API: The back end is built using Ruby on Rails, creating an API endpoint to generate a random greeting message.

```json
{
"greeting": "Hello, Friend!"
}
```

(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-backend-app.git
```

### 📥 Installation

Install the required gems with:

```sh
bundle 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
```

### 💻 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.

## 👤 Besufekad Alemu

- GitHub: [@Besufekad-HAZ](https://github.com/Besufekad-HAZ)
- Twitter: [@BesufekadAlemu7](https://twitter.com/BesufekadAlemu7)
- LinkedIn: [@besura](www.linkedin.com/in/besura)

(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 the Microverse team for providing us this learning platform by building projects.

(back to top)

## 📜 License

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

(back to top)