ITurres / hello_rails_react

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hello Rails + React


πŸ“— Table of Contents


πŸ“– 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 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.

Setup

Clone this repository to your desired folder:

Example commands:

  • With SSH:
  cd my-folder
  git clone git@github.com:ITurres/hello_rails_react.git
  • With HTTPS:
  cd my-folder
  git clone https://github.com/ITurres/hello_rails_react.git
  • With GitHub CLI:
  cd my-folder
  gh repo clone ITurres/hello_rails_react

Install

Go to the project directory:

 cd hello_rails_react

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

 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

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

 bundle install

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

 rails db:create

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

 rails db:migrate
 rails db:seed

Usage

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

 ./bin/dev

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

Run tests

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

 bundle exec rspec

(back to top)


πŸ‘₯ Authors

πŸ‘€ Arthur Iturres

(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.

(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 licensed.

(back to top)


About

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

License:MIT License


Languages

Language:Ruby 65.2%Language:HTML 14.5%Language:JavaScript 11.3%Language:Dockerfile 6.0%Language:CSS 1.8%Language:Shell 1.1%