Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iturres/hello_rails_react

πŸ› οΈ Connection setup for Ruby on Rails back-end and React front-end projects with Webpack.
https://github.com/iturres/hello_rails_react

Last synced: 1 day ago
JSON representation

πŸ› οΈ Connection setup for Ruby on Rails back-end and React front-end projects with Webpack.

Awesome Lists containing this project

README

        


Hello Rails + React


---

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸ’» Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [πŸ“ License](#license)

---

# πŸ“– Hello Rails + React

> Hello Rails + React is a project that aims to connect a Ruby on Rails back-end with a React front-end.

#### Learning objectives

- Implement a connection between a Ruby on Rails back-end and React front-end.
- Understand the pros and cons of different approaches of connecting Ruby on Rails back-end with React front-end.

## πŸ›  Built With

### Tech Stack

---

### :key: Key Features

- Rails back-end with React front-end.

---

(back to top)

---

## πŸ’» Getting Started

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

### Prerequisites

To run this project you need:

- Have Ruby installed. If you need to install Ruby, follow the instructions on the [official page](https://www.ruby-lang.org/en/documentation/installation/).

### Setup

Clone this repository to your desired folder:

Example commands:

- With SSH:

```bash
cd my-folder
git clone [email protected]:ITurres/hello_rails_react.git
```

- With HTTPS:

```bash
cd my-folder
git clone https://github.com/ITurres/hello_rails_react.git
```

- With GitHub CLI:

```bash
cd my-folder
gh repo clone ITurres/hello_rails_react
```

### Install

Go to the project directory:

```bash
cd hello_rails_react
```

Before running the program, verify that you have Ruby on Rails installed on your OS by running the following command:

```bash
rails --version
```

It should show you the version of Ruby On Rails ​​installed. If this does not happen and only an error message is displayed, you should verify your installation or install Ruby on Rails from scratch.

[Download and Install Ruby on Rails](https://guides.rubyonrails.org/getting_started.html)

Once you have verified that you have Ruby on Rails installed, run the following command to install the necessary gems:

```bash
bundle install
```

After installing the gems, run the following command to create the database:

```bash
rails db:create
```

Then run the following command to migrate the database and seed it with the necessary data:

```bash
rails db:migrate
rails db:seed
```

### Usage

Run the following command inside the project folder to start the application:

```bash
./bin/dev
```

This will start the application on your local server. You can now open your browser and go to [http://localhost:3000/](http://localhost:3000/) to see the application running.

### Run tests

To execute the tests, run the following command inside the project folder (root):

```bash
bundle exec rspec
```

(back to top)

---

## πŸ‘₯ Authors

πŸ‘€ **Arthur Iturres**

- GitHub: [@ITurres](https://github.com/ITurres)
- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)
- Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres)
- Youtube: [Arturo Emanuel Guerra Iturres - Youtube Channel](https://www.youtube.com/channel/UC6GFUFHOtBS9mOuI8EJ6q4g)
- Portfolio: [Arthur Iturres - Portfolio](https://iturres.github.io/iturres-reactive-portfolio/)

(back to top)

---

## πŸ”­ Future Features

- [ ] Style the application.

(back to top)

---

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Kindly open any new issues or feature requests on the [repo's issues page](https://github.com/ITurres/hello_rails_react/issues).

(back to top)

---

## ⭐️ Show your support

Give a ⭐ if you liked this project!

(back to top)

---

## πŸ™ Acknowledgments

I thank the **Code Reviewers** for their advice and time πŸ†

(back to top)

---

## πŸ“ License

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

(back to top)

---