Gleennkar / hello-rails-react

Implement a connection between a Ruby on Rails back-end and React front-end.

Hello Rails React API App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hello Rails React API App
  • 🛠 Built With
    • Ruby on Rails
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hello Rails React API App

The Hello Rails React API App is a combined Rails and React API based web application that returns different kinds of greetings via an API endpoint that is interfaced with a React Front End application that consuming the API endpoints bundled together with WEBPACK.

🛠 Built With

Ruby on Rails

Client

• React.js

Server

• Ruby

Database

• PostgreSQL

Key Features

• API Endpoints
• Database management with Postgres
• ORM with ActiveRecord
• React Front End
• Bundled with WebPack

(back to top)

🚀 Live Demo

A live demo link will be added soon.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

Ruby installed

Postgresql installed

gem install rails

npm install

Setup

Clone this repository to your desired folder:

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

cd hello-rails-react

Install

bundle install

Usage

To run the project, execute the following command:

rails server

OR ./bin/dev

Run tests

To run tests, run the following command:

rspec

(back to top)

👥 Authors

Odette Gleen

• GitHub: @Gleennkar
• Twitter: @gleeny24
• LinkedIn: @gleeny

(back to top)

🔭 Future Features

• API Documentation with Swagger
• Build a separate Rails BackEnd and React Front End

(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 add a ⭐️

(back to top)

🙏 Acknowledgments

Credit to Microverse for the project specification

(back to top)

📝 License

This project is MIT licensed.

(back to top)