https://github.com/gleennkar/hello-rails-react

Implement a connection between a Ruby on Rails back-end and React front-end.
https://github.com/gleennkar/hello-rails-react

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/gleennkar/hello-rails-react
• Owner: Gleennkar
• License: mit
• Created: 2023-02-28T20:36:23.000Z (over 3 years ago)
• Default Branch: Dev
• Last Pushed: 2023-03-03T05:07:02.000Z (over 3 years ago)
• Last Synced: 2024-05-18T15:24:55.282Z (about 2 years ago)
• Language: Ruby
• Size: 158 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  


  
Hello Rails React API App




# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Hello Rails React API App ](#-hello-rails-react-api-app-)

  - [🛠 Built With ](#-built-with-)

    - [Ruby on Rails ](#ruby-on-rails-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-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](https://github.com/Gleennkar)

- Twitter: [@gleeny24](https://twitter.com/twitterhandle)

- LinkedIn: [@gleeny](https://www.linkedin.com/in/gleeny-nkar-aa3917182)

(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](https://github.com/Gleennkar/hello-rails-react/issues).

(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](./License) licensed.

(back to top)