📗 Table of Contents

📖 About the Project
- 🛠 Built With
  - Tech Stack
  - Key Features
💻 Getting Started
- Prerequisites
- Setup
👥 Authors
🤝 Contributing
🙏 Acknowledgements

📖 Hello React Rails

Hello React Rails is a hello world project I used to practice integrating rails with react and redux.

🛠 Built With

Tech Stack

Client

React.js

Server

Ruby on Rails

Database

PostgreSQL

Key Features

Some features of the application.

Rails api
React view
Redux data management

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

Ruby runtime environment
Postgresql
Rails
React.js
Redux

Setup

Clone this repository to your desired folder:

-Download the ZIP from this location, or run the following git command to clone the files to your machine.

Once the files are on your machine, open the hello-react-redux folder in your code editor.
Open the config/database.yml file in the project directory and change the username and password to your PostgreSQL username and password. Edit the default section of the file to look like this:

  default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # http://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <your PostgreSQL role username>
  password: <your PostgreSQL role password>

Use the following commands to
- install necessary gems bundle install
- rails db:create, rails db:migrate to setup the database
- rails s to start the server
For frontend:
- Clone this repository
- install dependecies with npm install
- run npm start to start the server