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

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

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/hetrox8/hello-rails-react
• Owner: hetrox8
• Created: 2023-11-29T14:16:30.000Z (about 1 year ago)
• Default Branch: development
• Last Pushed: 2023-12-01T03:24:53.000Z (about 1 year ago)
• Last Synced: 2024-12-23T21:24:20.292Z (about 1 month ago)
• Language: Ruby
• Size: 404 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






# 📗 Table of Contents

- [📖 About the Project](#about-project)

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#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:

  - A text editor of your choice ([VS Code](https://code.visualstudio.com/download) works well).

  - [Ruby and Rails](https://gorails.com/setup/windows/10)

  - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

### Setup

Use the following URL to clone this project:

   https://github.com/hetrox8/hello-rails-react.git

### Install

Open the terminal in the root directory of the project and run the folloeing 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 

👤 **Suleiman Gacheru**

- GitHub: [@hetrox8](https://github.com/hetrox8)

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

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

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