📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
  • 🔭 Future Features
• ⭐️ Show your support
• 📝 License

📖 Hello_rails_react_app

A simple demonstration react-rails app that shows a random message sent from the backend, by the request from the client side.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User can see a random greeting message sent from the backend.

(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 installed in your machine, you can user this link to install in your OS.
• PostgreSQL is installed in your machine, you can refer this link to install in your machine. Then run:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/SekoViper/hello-rails-react.git

  cd hello-rails-react

Install

Run these commands to install the required dependencies:

  bundle install

  npm install

  yarn install

Usage

To run the project, execute the following command:

  ./bin/dev

👥 Author

• GitHub: @SekoViper
• LinkedIn: Dameh Livingstone

(back to top)

🔭 Future Features

• Create API documentation using rswag
• Add testing for react and rails.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

📝 License

This project is MIT licensed.

(back to top)