Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

This repository contains a sample project that demonstrates how to connect a Ruby on Rails back-end with a React front-end. The goal of this exercise is to apply previous knowledge of using gems with Rails to connect the back-end with the front-end, while also introducing new techniques for handling JavaScript assets in a Rails application.
https://github.com/onjoseph/hello-rails-react

css html jsx postgresql rails react reactjs ruby

Last synced: about 1 month ago
JSON representation

This repository contains a sample project that demonstrates how to connect a Ruby on Rails back-end with a React front-end. The goal of this exercise is to apply previous knowledge of using gems with Rails to connect the back-end with the front-end, while also introducing new techniques for handling JavaScript assets in a Rails application.

Awesome Lists containing this project

README

        


logo

Hello World Rails React

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo & Project Presentation](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Hello Rails React App

This repository contains a sample project that demonstrates how to connect a Ruby on Rails back-end with a React front-end. The goal of this exercise is to apply previous knowledge of using gems with Rails to connect the back-end with the front-end, while also introducing new techniques for handling JavaScript assets in a Rails application.

## 🛠 Built With

### Tech Stack

This project was implemented using:

Client

Server

Database

### Key Features

- **Display a random greeting generated through an api call to rails database, front-end using react**

## 💻 Getting Started

To get a local copy up and running, follow these steps:

### Prerequisites

In order to run this project you need to have installed:

- [ ] You’ll need to have Ruby and Rails on your machine.

Optionally, in order to modify this project you should to have installed:

- [ ] Git.

- [ ] Code editor like: [Visual Studio code](https://code.visualstudio.com/), or others...

### Setup

To clone this repository to your desired folder:

- You can download the **Zip** file from the GitHub repository, or clone the repository with:

```console
git clone https://github.com/ONJoseph/hello-rails-react.git
```

- Access the cloned directory with:

```console
cd hello-rails-react
```

- Open it with your favorite code editor or with the live server

### Usage

It is required that you setup your database to run this project, check the config/database.yml and make sure that the username and password match you postgresql setup, then run:

```console
yarn
```

```console
rails db:create
```

```console
rails db:migrate
```

To run the front-end, execute the following commands in the project directory:

```console
yarn build --watch
```

To run the project, execute the following command in the project directory:

```console
rails server
```

(back to top)

## 👥 Authors

👤 **Joseph Ogbole**

- GitHub: [@ONJoseph](https://github.com/ONJoseph)
- Twitter: [@ONJoseph1](https://twitter.com/ONJoseph1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/o-n-joseph-ba8425147/)

(back to top)

## 🔭 Future Features

We will implement this on the future:

- [ ] **Improve the user interface**
- [ ] **Add other features**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ONJoseph/hello-rails-react/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- [Microverse](https://www.microverse.org/) for the motivation.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)