Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

logo

RAILS_REACT WEB APPLICATION

# πŸ“— 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)

# πŸ“– Rails_React

**RailsReact** is web app to display greetings from rails API with react as the front-end using webpack in one app

## πŸ›  Built With

### Tech Stack

> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

> [React](https://reactjs.org/) React is a declarative, efficient, and flexible JavaScript library for building user interfaces. It lets you compose complex UIs from small and isolated pieces of code called β€œcomponents”.

> [Webpack](https://webpack.js.org/concepts/) is a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph from one or more entry points and then combines every module your project needs into one or more bundles, which are static assets to serve your content from.

Client

Server

Database

### Key Features

> Key features of the application are

- **Display of content from API**

(back to top)

## πŸš€ Live Demo

> Add a link to your deployed project.

- [Live Demo coming soon...](https://yourdeployedapplicationlink.com)

(back to top)

## πŸ’» Getting Started

> This project can be used by anyone for any good purpose.

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

### Prerequisites

In order to run this project you need:

- [Ruby and Rails on you operating system eg. for Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
- [PostgreSQL](https://www.postgresql.org/) database installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/DuaneDave/hello-react-rails.git
```

### Install

Install this project with:

```sh
cd hello-rails-react

bundle install
```

### Usage

To run the project, execute the following command:

```sh
./bin/dev
```

### Run tests

To run tests, run the following command:

```sh
bin/rails rspec spec
```

### Deployment

You can deploy this project using:

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Obiebi David**

- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)

(back to top)

## πŸ”­ Future Features

- Coming Soon ...

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/DuaneDave/hello-react-rails/issues).

(back to top)

## ⭐️ Show your support

If you like this project buy me a [drink](.../.../)

(back to top)

## πŸ™ Acknowledgments

> Give credit to everyone who inspired your codebase.

We would like to thank [Microverse](https://www.microverse.org/) for inspiring this project

(back to top)

## ❓ FAQ

- **Is Rails still relevant?**

- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)

- **Is it easy to learn Ruby on Rails**

- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)

(back to top)

## πŸ“ License

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

(back to top)