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

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

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/xsidx/hello-rails-react
• Owner: XsidX
• Created: 2022-11-21T09:18:49.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2022-11-21T16:21:48.000Z (over 3 years ago)
• Last Synced: 2025-01-20T15:19:09.140Z (over 1 year ago)
• Language: Ruby
• Size: 777 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          




  

  


  
Microverse README Template




# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 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)


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

### Install

Install this project with:

- Clone the repository using `git@github.com:XsidX/hello-rails-react.git`

- Navigate to the folder using `cd hello-rails-react`

- Use the following commands to

    - install necessary gems `bundle install`

    - run the development server `./bin/dev`

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:

### Deployment

You can deploy this project using:

(back to top)


## 👥 Author 

👤 **Sidney**

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

- Twitter: [@\_sid_o](https://twitter.com/_sid_o_)

- LinkedIn: [Sidney Kaguli](https://www.linkedin.com/in/sidney-kaguli)

(back to top)


(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> Write a message to encourage readers to support your project

If you like this project...

(back to top)


## 🙏 Acknowledgments 

I would like to thank microverse for providing the curriculum to guide me on this project.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/XsidX/hello-rails-react/blob/hello-react-rails/MIT.md) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)