wineshuga / hello-rails-react

Rails-React

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hello Rails-React
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hello Rails-React

Hello Rails-React Is a fullstack app that combines Ruby on Rails for the back end and React for the front end. The Ruby on Rails app provides JSON-formated data through an API endpoint that is then consumed by the React app and rendered on the browser. This project can be used as a template for simple Rails-React applications.

🛠 Built With

Tech Stack

Client

• React
• React-Redux
• Redux Toolkit

-

Server

• Ruby on Rails
• PostgreSQL

Key Features

• Rails API backend
• React Front-end
• Redux Toolkit used to consume the backend api

(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 and Rails
• Git

Setup

Clone this project:

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

Install

Open the terminal in the root directory of the project and run the following command to install all dependencies.

bundle install
npm i

Usage

To start the development server, run the following command then navigate to localhost:3000 in your browser.

./bin/dev

Run tests

There are no tests to run.

(back to top)

👥 Authors

👤 Alfred M.

• GitHub: @wineshuga
• X: @wineshuga
• LinkedIn: linkedin

(back to top)

🔭 Future Features

• None planned

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a star ⭐️ and share it with your friends.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the resources and guidelines that enabled me to complete this project.

(back to top)

📝 License

This project is MIT licensed.