https://github.com/faranoshamini/hello_rails_react

https://github.com/faranoshamini/hello_rails_react

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/faranoshamini/hello_rails_react
• Owner: FaranoshAmini
• License: mit
• Created: 2023-11-03T20:15:51.000Z (over 1 year ago)
• Default Branch: Development
• Last Pushed: 2023-11-11T17:35:01.000Z (over 1 year ago)
• Last Synced: 2025-02-04T14:48:00.197Z (4 months ago)
• Language: Ruby
• Size: 110 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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)

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

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Hello_React_Rails] 

**[Hello_React_Rails]** is a Hello world project to learn about React with rails configuration.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

  


  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

- **[View Random recipes]**

- **[Navigate through application]**

- **[View new messages on refresh]**

(back to top)


## 🚀 Live Demo 

> Demo not available

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

- Rails

- Node Package Manager

- Version Control System

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:myaccount/hello-rails-react.git

```

### Install

Install this project with:

```sh

  cd my-project

  bundle install

```

### Usage

To run the project, execute the following command:

```sh

  rails server

```

### Run tests

To run tests, run the following command:

```sh

  rails test test/models/article_test.rb

```

### Deployment

You can deploy this project using:

Deployment not available yet.

(back to top)


## 👥 Author 

👤 **Faranosh Amini**

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/faranosh-amini/)

- Twitter: [Twitter](https://twitter.com/Faranosh_Amini)

(back to top)


## 🔭 Future Features 

- [ ] **[Displaying_more_messages]**

- [ ] **[Refreshing_messages]**

- [ ] **[Adding_custom_messages]**

(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 feel free to support.

(back to top)


## 🙏 Acknowledgments 

> Give credit to everyone who inspired your codebase.

I would like to thank Microverse team for providing linters config files.

(back to top)


## 📝 License 

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

(back to top)