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

https://github.com/alejandroq12/hello-rails-react-one-app-template

rails-react-one-app-template
https://github.com/alejandroq12/hello-rails-react-one-app-template

postgresql reactjs ruby-on-rails

Last synced: 2 months ago
JSON representation

rails-react-one-app-template

Awesome Lists containing this project

README

        

# React-with-Rails-Webpack-template



main-logo


React with Ruby on Rails - Webpack template.



# 📗 Table of Contents

- [React-with-Rails-Webpack-template](#react-with-rails-webpack-template)
- [📗 Table of Contents](#-table-of-contents)
- [📖 React with Ruby on Rails - Webpack template. ](#-react-with-ruby-on-rails---webpack-template-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Run linter](#run-linter)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 React with Ruby on Rails - Webpack template.

The "React with Ruby on Rails - Webpack" project serves as a template for creating full-stack applications. It integrates Ruby on Rails with React.js and Redux, employs PostgreSQL for database management, and compiles the code using Webpack. This combination offers a comprehensive environment for developing modern web applications.

## 🛠 Built With

### Tech Stack

### Key Features

- **It allows you to fetch a random greeting**
- **A template to create future projects.**

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

[Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)

### Setup

```sh
cd my-folder
git clone https://github.com/Alejandroq12/hello-rails-react-one-app-template.git
```

### Install

Install all necessary dependencies listed in the `Gemfile`.

```sh
bundle install
```

Install all necessary dependencies listed in the `package.json`.

```sh
npm install
```

### Database

```sh
sudo service postgresql start
```

Create database:

```sh
rails db:create
```

Run migrations:

```sh
rails db:migrate
```

Add the seeds:

```sh
rails db:seed
```

### Usage

To run the project, navigate to the project directory and execute the following command:

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

### Run tests
Tests will be available soon!

### Run linter

To run linter, run the following command:

```sh
rubocop

```
```sh
npx stylelint "**/*.{css,scss}"
```

### Deployment

It does not apply because it is a template.

(back to top)

## 👥 Authors

👤 **Julio Quezada**

- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)

(back to top)

## 🔭 Future Features

- [ ] **You may use this template to create your own projects.**

(back to top)

## 🤝 Contributing

Contributions, [issues](https://github.com/Alejandroq12/hello-rails-react-one-app-template/issues), and feature requests are welcome!

(back to top)

## ⭐️ Show your support

If you like this project please give a star.
Thanks in advance.

(back to top)

## 🙏 Acknowledgments

Thank you to all my colleagues who always inspire me to more than my best.

(back to top)

## ❓ FAQ

**What did you learn?**

I learned how to set up a full-stack project template using Ruby on Rails, React.js, Redux, PostgreSQL, and Webpack, which is very important foundational knowledge for understanding more about these technologies and their interplay.

(back to top)

## 📝 License

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

(back to top)